sv.c

   1 /*    sv.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 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 PERL_UTF8_CACHE_ASSERT
  28 /* The cache element 0 is the Unicode offset;
  29  * the cache element 1 is the byte offset of the element 0;
  30  * the cache element 2 is the Unicode length of the substring;
  31  * the cache element 3 is the byte length of the substring;
  32  * The checking of the substring side would be good
  33  * but substr() has enough code paths to make my head spin;
  34  * if adding more checks watch out for the following tests:
  35  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
  36  *   lib/utf8.t lib/Unicode/Collate/t/index.t
  37  * --jhi
  38  */
  39 #define ASSERT_UTF8_CACHE(cache) \
  40         STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
  41 #else
  42 #define ASSERT_UTF8_CACHE(cache) NOOP
  43 #endif
  44
  45 #ifdef PERL_COPY_ON_WRITE
  46 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
  47 #define SV_COW_NEXT_SV_SET(current,next)        SvUVX(current) = PTR2UV(next)
  48 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
  49    on-write.  */
  50 #endif
  51
  52 /* ============================================================================
  53
  54 =head1 Allocation and deallocation of SVs.
  55
  56 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
  57 av, hv...) contains type and reference count information, as well as a
  58 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
  59 specific to each type.
  60
  61 Normally, this allocation is done using arenas, which are approximately
  62 1K chunks of memory parcelled up into N heads or bodies. The first slot
  63 in each arena is reserved, and is used to hold a link to the next arena.
  64 In the case of heads, the unused first slot also contains some flags and
  65 a note of the number of slots.  Snaked through each arena chain is a
  66 linked list of free items; when this becomes empty, an extra arena is
  67 allocated and divided up into N items which are threaded into the free
  68 list.
  69
  70 The following global variables are associated with arenas:
  71
  72     PL_sv_arenaroot     pointer to list of SV arenas
  73     PL_sv_root          pointer to list of free SV structures
  74
  75     PL_foo_arenaroot    pointer to list of foo arenas,
  76     PL_foo_root         pointer to list of free foo bodies
  77                             ... for foo in xiv, xnv, xrv, xpv etc.
  78
  79 Note that some of the larger and more rarely used body types (eg xpvio)
  80 are not allocated using arenas, but are instead just malloc()/free()ed as
  81 required. Also, if PURIFY is defined, arenas are abandoned altogether,
  82 with all items individually malloc()ed. In addition, a few SV heads are
  83 not allocated from an arena, but are instead directly created as static
  84 or auto variables, eg PL_sv_undef.
  85
  86 The SV arena serves the secondary purpose of allowing still-live SVs
  87 to be located and destroyed during final cleanup.
  88
  89 At the lowest level, the macros new_SV() and del_SV() grab and free
  90 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
  91 to return the SV to the free list with error checking.) new_SV() calls
  92 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
  93 SVs in the free list have their SvTYPE field set to all ones.
  94
  95 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
  96 that allocate and return individual body types. Normally these are mapped
  97 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
  98 instead mapped directly to malloc()/free() if PURIFY is defined. The
  99 new/del functions remove from, or add to, the appropriate PL_foo_root
 100 list, and call more_xiv() etc to add a new arena if the list is empty.
 101
 102 At the time of very final cleanup, sv_free_arenas() is called from
 103 perl_destruct() to physically free all the arenas allocated since the
 104 start of the interpreter.  Note that this also clears PL_he_arenaroot,
 105 which is otherwise dealt with in hv.c.
 106
 107 Manipulation of any of the PL_*root pointers is protected by enclosing
 108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
 109 if threads are enabled.
 110
 111 The function visit() scans the SV arenas list, and calls a specified
 112 function for each SV it finds which is still live - ie which has an SvTYPE
 113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
 114 following functions (specified as [function that calls visit()] / [function
 115 called by visit() for each SV]):
 116
 117     sv_report_used() / do_report_used()
 118                         dump all remaining SVs (debugging aid)
 119
 120     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
 121                         Attempt to free all objects pointed to by RVs,
 122                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
 123                         try to do the same for all objects indirectly
 124                         referenced by typeglobs too.  Called once from
 125                         perl_destruct(), prior to calling sv_clean_all()
 126                         below.
 127
 128     sv_clean_all() / do_clean_all()
 129                         SvREFCNT_dec(sv) each remaining SV, possibly
 130                         triggering an sv_free(). It also sets the
 131                         SVf_BREAK flag on the SV to indicate that the
 132                         refcnt has been artificially lowered, and thus
 133                         stopping sv_free() from giving spurious warnings
 134                         about SVs which unexpectedly have a refcnt
 135                         of zero.  called repeatedly from perl_destruct()
 136                         until there are no SVs left.
 137
 138 =head2 Summary
 139
 140 Private API to rest of sv.c
 141
 142     new_SV(),  del_SV(),
 143
 144     new_XIV(), del_XIV(),
 145     new_XNV(), del_XNV(),
 146     etc
 147
 148 Public API:
 149
 150     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
 151
 152
 153 =cut
 154
 155 ============================================================================ */
 156
 157
 158
 159 /*
 160  * "A time to plant, and a time to uproot what was planted..."
 161  */
 162
 163 #define plant_SV(p) \
 164     STMT_START {                                        \
 165         SvANY(p) = (void *)PL_sv_root;                  \
 166         SvFLAGS(p) = SVTYPEMASK;                        \
 167         PL_sv_root = (p);                               \
 168         --PL_sv_count;                                  \
 169     } STMT_END
 170
 171 /* sv_mutex must be held while calling uproot_SV() */
 172 #define uproot_SV(p) \
 173     STMT_START {                                        \
 174         (p) = PL_sv_root;                               \
 175         PL_sv_root = (SV*)SvANY(p);                     \
 176         ++PL_sv_count;                                  \
 177     } STMT_END
 178
 179
 180 /* new_SV(): return a new, empty SV head */
 181
 182 #ifdef DEBUG_LEAKING_SCALARS
 183 /* provide a real function for a debugger to play with */
 184 STATIC SV*
 185 S_new_SV(pTHX)
 186 {
 187     SV* sv;
 188
 189     LOCK_SV_MUTEX;
 190     if (PL_sv_root)
 191         uproot_SV(sv);
 192     else
 193         sv = more_sv();
 194     UNLOCK_SV_MUTEX;
 195     SvANY(sv) = 0;
 196     SvREFCNT(sv) = 1;
 197     SvFLAGS(sv) = 0;
 198     return sv;
 199 }
 200 #  define new_SV(p) (p)=S_new_SV(aTHX)
 201
 202 #else
 203 #  define new_SV(p) \
 204     STMT_START {                                        \
 205         LOCK_SV_MUTEX;                                  \
 206         if (PL_sv_root)                                 \
 207             uproot_SV(p);                               \
 208         else                                            \
 209             (p) = more_sv();                            \
 210         UNLOCK_SV_MUTEX;                                \
 211         SvANY(p) = 0;                                   \
 212         SvREFCNT(p) = 1;                                \
 213         SvFLAGS(p) = 0;                                 \
 214     } STMT_END
 215 #endif
 216
 217
 218 /* del_SV(): return an empty SV head to the free list */
 219
 220 #ifdef DEBUGGING
 221
 222 #define del_SV(p) \
 223     STMT_START {                                        \
 224         LOCK_SV_MUTEX;                                  \
 225         if (DEBUG_D_TEST)                               \
 226             del_sv(p);                                  \
 227         else                                            \
 228             plant_SV(p);                                \
 229         UNLOCK_SV_MUTEX;                                \
 230     } STMT_END
 231
 232 STATIC void
 233 S_del_sv(pTHX_ SV *p)
 234 {
 235     if (DEBUG_D_TEST) {
 236         SV* sva;
 237         SV* sv;
 238         SV* svend;
 239         int ok = 0;
 240         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
 241             sv = sva + 1;
 242             svend = &sva[SvREFCNT(sva)];
 243             if (p >= sv && p < svend)
 244                 ok = 1;
 245         }
 246         if (!ok) {
 247             if (ckWARN_d(WARN_INTERNAL))
 248                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
 249                             "Attempt to free non-arena SV: 0x%"UVxf,
 250                             PTR2UV(p));
 251             return;
 252         }
 253     }
 254     plant_SV(p);
 255 }
 256
 257 #else /* ! DEBUGGING */
 258
 259 #define del_SV(p)   plant_SV(p)
 260
 261 #endif /* DEBUGGING */
 262
 263
 264 /*
 265 =head1 SV Manipulation Functions
 266
 267 =for apidoc sv_add_arena
 268
 269 Given a chunk of memory, link it to the head of the list of arenas,
 270 and split it into a list of free SVs.
 271
 272 =cut
 273 */
 274
 275 void
 276 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
 277 {
 278     SV* sva = (SV*)ptr;
 279     register SV* sv;
 280     register SV* svend;
 281     Zero(ptr, size, char);
 282
 283     /* The first SV in an arena isn't an SV. */
 284     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
 285     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
 286     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
 287
 288     PL_sv_arenaroot = sva;
 289     PL_sv_root = sva + 1;
 290
 291     svend = &sva[SvREFCNT(sva) - 1];
 292     sv = sva + 1;
 293     while (sv < svend) {
 294         SvANY(sv) = (void *)(SV*)(sv + 1);
 295         SvFLAGS(sv) = SVTYPEMASK;
 296         sv++;
 297     }
 298     SvANY(sv) = 0;
 299     SvFLAGS(sv) = SVTYPEMASK;
 300 }
 301
 302 /* make some more SVs by adding another arena */
 303
 304 /* sv_mutex must be held while calling more_sv() */
 305 STATIC SV*
 306 S_more_sv(pTHX)
 307 {
 308     register SV* sv;
 309
 310     if (PL_nice_chunk) {
 311         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
 312         PL_nice_chunk = Nullch;
 313         PL_nice_chunk_size = 0;
 314     }
 315     else {
 316         char *chunk;                /* must use New here to match call to */
 317         New(704,chunk,1008,char);   /* Safefree() in sv_free_arenas()     */
 318         sv_add_arena(chunk, 1008, 0);
 319     }
 320     uproot_SV(sv);
 321     return sv;
 322 }
 323
 324 /* visit(): call the named function for each non-free SV in the arenas. */
 325
 326 STATIC I32
 327 S_visit(pTHX_ SVFUNC_t f)
 328 {
 329     SV* sva;
 330     SV* sv;
 331     register SV* svend;
 332     I32 visited = 0;
 333
 334     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
 335         svend = &sva[SvREFCNT(sva)];
 336         for (sv = sva + 1; sv < svend; ++sv) {
 337             if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
 338                 (FCALL)(aTHX_ sv);
 339                 ++visited;
 340             }
 341         }
 342     }
 343     return visited;
 344 }
 345
 346 #ifdef DEBUGGING
 347
 348 /* called by sv_report_used() for each live SV */
 349
 350 static void
 351 do_report_used(pTHX_ SV *sv)
 352 {
 353     if (SvTYPE(sv) != SVTYPEMASK) {
 354         PerlIO_printf(Perl_debug_log, "****\n");
 355         sv_dump(sv);
 356     }
 357 }
 358 #endif
 359
 360 /*
 361 =for apidoc sv_report_used
 362
 363 Dump the contents of all SVs not yet freed. (Debugging aid).
 364
 365 =cut
 366 */
 367
 368 void
 369 Perl_sv_report_used(pTHX)
 370 {
 371 #ifdef DEBUGGING
 372     visit(do_report_used);
 373 #endif
 374 }
 375
 376 /* called by sv_clean_objs() for each live SV */
 377
 378 static void
 379 do_clean_objs(pTHX_ SV *sv)
 380 {
 381     SV* rv;
 382
 383     if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
 384         DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
 385         if (SvWEAKREF(sv)) {
 386             sv_del_backref(sv);
 387             SvWEAKREF_off(sv);
 388             SvRV(sv) = 0;
 389         } else {
 390             SvROK_off(sv);
 391             SvRV(sv) = 0;
 392             SvREFCNT_dec(rv);
 393         }
 394     }
 395
 396     /* XXX Might want to check arrays, etc. */
 397 }
 398
 399 /* called by sv_clean_objs() for each live SV */
 400
 401 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 402 static void
 403 do_clean_named_objs(pTHX_ SV *sv)
 404 {
 405     if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
 406         if ( SvOBJECT(GvSV(sv)) ||
 407              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
 408              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
 409              (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
 410              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
 411         {
 412             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
 413             SvREFCNT_dec(sv);
 414         }
 415     }
 416 }
 417 #endif
 418
 419 /*
 420 =for apidoc sv_clean_objs
 421
 422 Attempt to destroy all objects not yet freed
 423
 424 =cut
 425 */
 426
 427 void
 428 Perl_sv_clean_objs(pTHX)
 429 {
 430     PL_in_clean_objs = TRUE;
 431     visit(do_clean_objs);
 432 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 433     /* some barnacles may yet remain, clinging to typeglobs */
 434     visit(do_clean_named_objs);
 435 #endif
 436     PL_in_clean_objs = FALSE;
 437 }
 438
 439 /* called by sv_clean_all() for each live SV */
 440
 441 static void
 442 do_clean_all(pTHX_ SV *sv)
 443 {
 444     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
 445     SvFLAGS(sv) |= SVf_BREAK;
 446     SvREFCNT_dec(sv);
 447 }
 448
 449 /*
 450 =for apidoc sv_clean_all
 451
 452 Decrement the refcnt of each remaining SV, possibly triggering a
 453 cleanup. This function may have to be called multiple times to free
 454 SVs which are in complex self-referential hierarchies.
 455
 456 =cut
 457 */
 458
 459 I32
 460 Perl_sv_clean_all(pTHX)
 461 {
 462     I32 cleaned;
 463     PL_in_clean_all = TRUE;
 464     cleaned = visit(do_clean_all);
 465     PL_in_clean_all = FALSE;
 466     return cleaned;
 467 }
 468
 469 /*
 470 =for apidoc sv_free_arenas
 471
 472 Deallocate the memory used by all arenas. Note that all the individual SV
 473 heads and bodies within the arenas must already have been freed.
 474
 475 =cut
 476 */
 477
 478 void
 479 Perl_sv_free_arenas(pTHX)
 480 {
 481     SV* sva;
 482     SV* svanext;
 483     XPV *arena, *arenanext;
 484
 485     /* Free arenas here, but be careful about fake ones.  (We assume
 486        contiguity of the fake ones with the corresponding real ones.) */
 487
 488     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
 489         svanext = (SV*) SvANY(sva);
 490         while (svanext && SvFAKE(svanext))
 491             svanext = (SV*) SvANY(svanext);
 492
 493         if (!SvFAKE(sva))
 494             Safefree((void *)sva);
 495     }
 496
 497     for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
 498         arenanext = (XPV*)arena->xpv_pv;
 499         Safefree(arena);
 500     }
 501     PL_xiv_arenaroot = 0;
 502     PL_xiv_root = 0;
 503
 504     for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
 505         arenanext = (XPV*)arena->xpv_pv;
 506         Safefree(arena);
 507     }
 508     PL_xnv_arenaroot = 0;
 509     PL_xnv_root = 0;
 510
 511     for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
 512         arenanext = (XPV*)arena->xpv_pv;
 513         Safefree(arena);
 514     }
 515     PL_xrv_arenaroot = 0;
 516     PL_xrv_root = 0;
 517
 518     for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
 519         arenanext = (XPV*)arena->xpv_pv;
 520         Safefree(arena);
 521     }
 522     PL_xpv_arenaroot = 0;
 523     PL_xpv_root = 0;
 524
 525     for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
 526         arenanext = (XPV*)arena->xpv_pv;
 527         Safefree(arena);
 528     }
 529     PL_xpviv_arenaroot = 0;
 530     PL_xpviv_root = 0;
 531
 532     for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
 533         arenanext = (XPV*)arena->xpv_pv;
 534         Safefree(arena);
 535     }
 536     PL_xpvnv_arenaroot = 0;
 537     PL_xpvnv_root = 0;
 538
 539     for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
 540         arenanext = (XPV*)arena->xpv_pv;
 541         Safefree(arena);
 542     }
 543     PL_xpvcv_arenaroot = 0;
 544     PL_xpvcv_root = 0;
 545
 546     for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
 547         arenanext = (XPV*)arena->xpv_pv;
 548         Safefree(arena);
 549     }
 550     PL_xpvav_arenaroot = 0;
 551     PL_xpvav_root = 0;
 552
 553     for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
 554         arenanext = (XPV*)arena->xpv_pv;
 555         Safefree(arena);
 556     }
 557     PL_xpvhv_arenaroot = 0;
 558     PL_xpvhv_root = 0;
 559
 560     for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
 561         arenanext = (XPV*)arena->xpv_pv;
 562         Safefree(arena);
 563     }
 564     PL_xpvmg_arenaroot = 0;
 565     PL_xpvmg_root = 0;
 566
 567     for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
 568         arenanext = (XPV*)arena->xpv_pv;
 569         Safefree(arena);
 570     }
 571     PL_xpvlv_arenaroot = 0;
 572     PL_xpvlv_root = 0;
 573
 574     for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
 575         arenanext = (XPV*)arena->xpv_pv;
 576         Safefree(arena);
 577     }
 578     PL_xpvbm_arenaroot = 0;
 579     PL_xpvbm_root = 0;
 580
 581     for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
 582         arenanext = (XPV*)arena->xpv_pv;
 583         Safefree(arena);
 584     }
 585     PL_he_arenaroot = 0;
 586     PL_he_root = 0;
 587
 588     if (PL_nice_chunk)
 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 =for apidoc report_uninit
 598
 599 Print appropriate "Use of uninitialized variable" warning
 600
 601 =cut
 602 */
 603
 604 void
 605 Perl_report_uninit(pTHX)
 606 {
 607     if (PL_op)
 608         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
 609                     " in ", OP_DESC(PL_op));
 610     else
 611         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
 612 }
 613
 614 /* grab a new IV body from the free list, allocating more if necessary */
 615
 616 STATIC XPVIV*
 617 S_new_xiv(pTHX)
 618 {
 619     IV* xiv;
 620     LOCK_SV_MUTEX;
 621     if (!PL_xiv_root)
 622         more_xiv();
 623     xiv = PL_xiv_root;
 624     /*
 625      * See comment in more_xiv() -- RAM.
 626      */
 627     PL_xiv_root = *(IV**)xiv;
 628     UNLOCK_SV_MUTEX;
 629     return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
 630 }
 631
 632 /* return an IV body to the free list */
 633
 634 STATIC void
 635 S_del_xiv(pTHX_ XPVIV *p)
 636 {
 637     IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
 638     LOCK_SV_MUTEX;
 639     *(IV**)xiv = PL_xiv_root;
 640     PL_xiv_root = xiv;
 641     UNLOCK_SV_MUTEX;
 642 }
 643
 644 /* allocate another arena's worth of IV bodies */
 645
 646 STATIC void
 647 S_more_xiv(pTHX)
 648 {
 649     register IV* xiv;
 650     register IV* xivend;
 651     XPV* ptr;
 652     New(705, ptr, 1008/sizeof(XPV), XPV);
 653     ptr->xpv_pv = (char*)PL_xiv_arenaroot;      /* linked list of xiv arenas */
 654     PL_xiv_arenaroot = ptr;                     /* to keep Purify happy */
 655
 656     xiv = (IV*) ptr;
 657     xivend = &xiv[1008 / sizeof(IV) - 1];
 658     xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1;  /* fudge by size of XPV */
 659     PL_xiv_root = xiv;
 660     while (xiv < xivend) {
 661         *(IV**)xiv = (IV *)(xiv + 1);
 662         xiv++;
 663     }
 664     *(IV**)xiv = 0;
 665 }
 666
 667 /* grab a new NV body from the free list, allocating more if necessary */
 668
 669 STATIC XPVNV*
 670 S_new_xnv(pTHX)
 671 {
 672     NV* xnv;
 673     LOCK_SV_MUTEX;
 674     if (!PL_xnv_root)
 675         more_xnv();
 676     xnv = PL_xnv_root;
 677     PL_xnv_root = *(NV**)xnv;
 678     UNLOCK_SV_MUTEX;
 679     return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
 680 }
 681
 682 /* return an NV body to the free list */
 683
 684 STATIC void
 685 S_del_xnv(pTHX_ XPVNV *p)
 686 {
 687     NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
 688     LOCK_SV_MUTEX;
 689     *(NV**)xnv = PL_xnv_root;
 690     PL_xnv_root = xnv;
 691     UNLOCK_SV_MUTEX;
 692 }
 693
 694 /* allocate another arena's worth of NV bodies */
 695
 696 STATIC void
 697 S_more_xnv(pTHX)
 698 {
 699     register NV* xnv;
 700     register NV* xnvend;
 701     XPV *ptr;
 702     New(711, ptr, 1008/sizeof(XPV), XPV);
 703     ptr->xpv_pv = (char*)PL_xnv_arenaroot;
 704     PL_xnv_arenaroot = ptr;
 705
 706     xnv = (NV*) ptr;
 707     xnvend = &xnv[1008 / sizeof(NV) - 1];
 708     xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
 709     PL_xnv_root = xnv;
 710     while (xnv < xnvend) {
 711         *(NV**)xnv = (NV*)(xnv + 1);
 712         xnv++;
 713     }
 714     *(NV**)xnv = 0;
 715 }
 716
 717 /* grab a new struct xrv from the free list, allocating more if necessary */
 718
 719 STATIC XRV*
 720 S_new_xrv(pTHX)
 721 {
 722     XRV* xrv;
 723     LOCK_SV_MUTEX;
 724     if (!PL_xrv_root)
 725         more_xrv();
 726     xrv = PL_xrv_root;
 727     PL_xrv_root = (XRV*)xrv->xrv_rv;
 728     UNLOCK_SV_MUTEX;
 729     return xrv;
 730 }
 731
 732 /* return a struct xrv to the free list */
 733
 734 STATIC void
 735 S_del_xrv(pTHX_ XRV *p)
 736 {
 737     LOCK_SV_MUTEX;
 738     p->xrv_rv = (SV*)PL_xrv_root;
 739     PL_xrv_root = p;
 740     UNLOCK_SV_MUTEX;
 741 }
 742
 743 /* allocate another arena's worth of struct xrv */
 744
 745 STATIC void
 746 S_more_xrv(pTHX)
 747 {
 748     register XRV* xrv;
 749     register XRV* xrvend;
 750     XPV *ptr;
 751     New(712, ptr, 1008/sizeof(XPV), XPV);
 752     ptr->xpv_pv = (char*)PL_xrv_arenaroot;
 753     PL_xrv_arenaroot = ptr;
 754
 755     xrv = (XRV*) ptr;
 756     xrvend = &xrv[1008 / sizeof(XRV) - 1];
 757     xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
 758     PL_xrv_root = xrv;
 759     while (xrv < xrvend) {
 760         xrv->xrv_rv = (SV*)(xrv + 1);
 761         xrv++;
 762     }
 763     xrv->xrv_rv = 0;
 764 }
 765
 766 /* grab a new struct xpv from the free list, allocating more if necessary */
 767
 768 STATIC XPV*
 769 S_new_xpv(pTHX)
 770 {
 771     XPV* xpv;
 772     LOCK_SV_MUTEX;
 773     if (!PL_xpv_root)
 774         more_xpv();
 775     xpv = PL_xpv_root;
 776     PL_xpv_root = (XPV*)xpv->xpv_pv;
 777     UNLOCK_SV_MUTEX;
 778     return xpv;
 779 }
 780
 781 /* return a struct xpv to the free list */
 782
 783 STATIC void
 784 S_del_xpv(pTHX_ XPV *p)
 785 {
 786     LOCK_SV_MUTEX;
 787     p->xpv_pv = (char*)PL_xpv_root;
 788     PL_xpv_root = p;
 789     UNLOCK_SV_MUTEX;
 790 }
 791
 792 /* allocate another arena's worth of struct xpv */
 793
 794 STATIC void
 795 S_more_xpv(pTHX)
 796 {
 797     register XPV* xpv;
 798     register XPV* xpvend;
 799     New(713, xpv, 1008/sizeof(XPV), XPV);
 800     xpv->xpv_pv = (char*)PL_xpv_arenaroot;
 801     PL_xpv_arenaroot = xpv;
 802
 803     xpvend = &xpv[1008 / sizeof(XPV) - 1];
 804     PL_xpv_root = ++xpv;
 805     while (xpv < xpvend) {
 806         xpv->xpv_pv = (char*)(xpv + 1);
 807         xpv++;
 808     }
 809     xpv->xpv_pv = 0;
 810 }
 811
 812 /* grab a new struct xpviv from the free list, allocating more if necessary */
 813
 814 STATIC XPVIV*
 815 S_new_xpviv(pTHX)
 816 {
 817     XPVIV* xpviv;
 818     LOCK_SV_MUTEX;
 819     if (!PL_xpviv_root)
 820         more_xpviv();
 821     xpviv = PL_xpviv_root;
 822     PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
 823     UNLOCK_SV_MUTEX;
 824     return xpviv;
 825 }
 826
 827 /* return a struct xpviv to the free list */
 828
 829 STATIC void
 830 S_del_xpviv(pTHX_ XPVIV *p)
 831 {
 832     LOCK_SV_MUTEX;
 833     p->xpv_pv = (char*)PL_xpviv_root;
 834     PL_xpviv_root = p;
 835     UNLOCK_SV_MUTEX;
 836 }
 837
 838 /* allocate another arena's worth of struct xpviv */
 839
 840 STATIC void
 841 S_more_xpviv(pTHX)
 842 {
 843     register XPVIV* xpviv;
 844     register XPVIV* xpvivend;
 845     New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
 846     xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
 847     PL_xpviv_arenaroot = xpviv;
 848
 849     xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
 850     PL_xpviv_root = ++xpviv;
 851     while (xpviv < xpvivend) {
 852         xpviv->xpv_pv = (char*)(xpviv + 1);
 853         xpviv++;
 854     }
 855     xpviv->xpv_pv = 0;
 856 }
 857
 858 /* grab a new struct xpvnv from the free list, allocating more if necessary */
 859
 860 STATIC XPVNV*
 861 S_new_xpvnv(pTHX)
 862 {
 863     XPVNV* xpvnv;
 864     LOCK_SV_MUTEX;
 865     if (!PL_xpvnv_root)
 866         more_xpvnv();
 867     xpvnv = PL_xpvnv_root;
 868     PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
 869     UNLOCK_SV_MUTEX;
 870     return xpvnv;
 871 }
 872
 873 /* return a struct xpvnv to the free list */
 874
 875 STATIC void
 876 S_del_xpvnv(pTHX_ XPVNV *p)
 877 {
 878     LOCK_SV_MUTEX;
 879     p->xpv_pv = (char*)PL_xpvnv_root;
 880     PL_xpvnv_root = p;
 881     UNLOCK_SV_MUTEX;
 882 }
 883
 884 /* allocate another arena's worth of struct xpvnv */
 885
 886 STATIC void
 887 S_more_xpvnv(pTHX)
 888 {
 889     register XPVNV* xpvnv;
 890     register XPVNV* xpvnvend;
 891     New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
 892     xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
 893     PL_xpvnv_arenaroot = xpvnv;
 894
 895     xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
 896     PL_xpvnv_root = ++xpvnv;
 897     while (xpvnv < xpvnvend) {
 898         xpvnv->xpv_pv = (char*)(xpvnv + 1);
 899         xpvnv++;
 900     }
 901     xpvnv->xpv_pv = 0;
 902 }
 903
 904 /* grab a new struct xpvcv from the free list, allocating more if necessary */
 905
 906 STATIC XPVCV*
 907 S_new_xpvcv(pTHX)
 908 {
 909     XPVCV* xpvcv;
 910     LOCK_SV_MUTEX;
 911     if (!PL_xpvcv_root)
 912         more_xpvcv();
 913     xpvcv = PL_xpvcv_root;
 914     PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
 915     UNLOCK_SV_MUTEX;
 916     return xpvcv;
 917 }
 918
 919 /* return a struct xpvcv to the free list */
 920
 921 STATIC void
 922 S_del_xpvcv(pTHX_ XPVCV *p)
 923 {
 924     LOCK_SV_MUTEX;
 925     p->xpv_pv = (char*)PL_xpvcv_root;
 926     PL_xpvcv_root = p;
 927     UNLOCK_SV_MUTEX;
 928 }
 929
 930 /* allocate another arena's worth of struct xpvcv */
 931
 932 STATIC void
 933 S_more_xpvcv(pTHX)
 934 {
 935     register XPVCV* xpvcv;
 936     register XPVCV* xpvcvend;
 937     New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
 938     xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
 939     PL_xpvcv_arenaroot = xpvcv;
 940
 941     xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
 942     PL_xpvcv_root = ++xpvcv;
 943     while (xpvcv < xpvcvend) {
 944         xpvcv->xpv_pv = (char*)(xpvcv + 1);
 945         xpvcv++;
 946     }
 947     xpvcv->xpv_pv = 0;
 948 }
 949
 950 /* grab a new struct xpvav from the free list, allocating more if necessary */
 951
 952 STATIC XPVAV*
 953 S_new_xpvav(pTHX)
 954 {
 955     XPVAV* xpvav;
 956     LOCK_SV_MUTEX;
 957     if (!PL_xpvav_root)
 958         more_xpvav();
 959     xpvav = PL_xpvav_root;
 960     PL_xpvav_root = (XPVAV*)xpvav->xav_array;
 961     UNLOCK_SV_MUTEX;
 962     return xpvav;
 963 }
 964
 965 /* return a struct xpvav to the free list */
 966
 967 STATIC void
 968 S_del_xpvav(pTHX_ XPVAV *p)
 969 {
 970     LOCK_SV_MUTEX;
 971     p->xav_array = (char*)PL_xpvav_root;
 972     PL_xpvav_root = p;
 973     UNLOCK_SV_MUTEX;
 974 }
 975
 976 /* allocate another arena's worth of struct xpvav */
 977
 978 STATIC void
 979 S_more_xpvav(pTHX)
 980 {
 981     register XPVAV* xpvav;
 982     register XPVAV* xpvavend;
 983     New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
 984     xpvav->xav_array = (char*)PL_xpvav_arenaroot;
 985     PL_xpvav_arenaroot = xpvav;
 986
 987     xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
 988     PL_xpvav_root = ++xpvav;
 989     while (xpvav < xpvavend) {
 990         xpvav->xav_array = (char*)(xpvav + 1);
 991         xpvav++;
 992     }
 993     xpvav->xav_array = 0;
 994 }
 995
 996 /* grab a new struct xpvhv from the free list, allocating more if necessary */
 997
 998 STATIC XPVHV*
 999 S_new_xpvhv(pTHX)
1000 {
1001     XPVHV* xpvhv;
1002     LOCK_SV_MUTEX;
1003     if (!PL_xpvhv_root)
1004         more_xpvhv();
1005     xpvhv = PL_xpvhv_root;
1006     PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1007     UNLOCK_SV_MUTEX;
1008     return xpvhv;
1009 }
1010
1011 /* return a struct xpvhv to the free list */
1012
1013 STATIC void
1014 S_del_xpvhv(pTHX_ XPVHV *p)
1015 {
1016     LOCK_SV_MUTEX;
1017     p->xhv_array = (char*)PL_xpvhv_root;
1018     PL_xpvhv_root = p;
1019     UNLOCK_SV_MUTEX;
1020 }
1021
1022 /* allocate another arena's worth of struct xpvhv */
1023
1024 STATIC void
1025 S_more_xpvhv(pTHX)
1026 {
1027     register XPVHV* xpvhv;
1028     register XPVHV* xpvhvend;
1029     New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1030     xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1031     PL_xpvhv_arenaroot = xpvhv;
1032
1033     xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1034     PL_xpvhv_root = ++xpvhv;
1035     while (xpvhv < xpvhvend) {
1036         xpvhv->xhv_array = (char*)(xpvhv + 1);
1037         xpvhv++;
1038     }
1039     xpvhv->xhv_array = 0;
1040 }
1041
1042 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1043
1044 STATIC XPVMG*
1045 S_new_xpvmg(pTHX)
1046 {
1047     XPVMG* xpvmg;
1048     LOCK_SV_MUTEX;
1049     if (!PL_xpvmg_root)
1050         more_xpvmg();
1051     xpvmg = PL_xpvmg_root;
1052     PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1053     UNLOCK_SV_MUTEX;
1054     return xpvmg;
1055 }
1056
1057 /* return a struct xpvmg to the free list */
1058
1059 STATIC void
1060 S_del_xpvmg(pTHX_ XPVMG *p)
1061 {
1062     LOCK_SV_MUTEX;
1063     p->xpv_pv = (char*)PL_xpvmg_root;
1064     PL_xpvmg_root = p;
1065     UNLOCK_SV_MUTEX;
1066 }
1067
1068 /* allocate another arena's worth of struct xpvmg */
1069
1070 STATIC void
1071 S_more_xpvmg(pTHX)
1072 {
1073     register XPVMG* xpvmg;
1074     register XPVMG* xpvmgend;
1075     New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1076     xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1077     PL_xpvmg_arenaroot = xpvmg;
1078
1079     xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1080     PL_xpvmg_root = ++xpvmg;
1081     while (xpvmg < xpvmgend) {
1082         xpvmg->xpv_pv = (char*)(xpvmg + 1);
1083         xpvmg++;
1084     }
1085     xpvmg->xpv_pv = 0;
1086 }
1087
1088 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1089
1090 STATIC XPVLV*
1091 S_new_xpvlv(pTHX)
1092 {
1093     XPVLV* xpvlv;
1094     LOCK_SV_MUTEX;
1095     if (!PL_xpvlv_root)
1096         more_xpvlv();
1097     xpvlv = PL_xpvlv_root;
1098     PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1099     UNLOCK_SV_MUTEX;
1100     return xpvlv;
1101 }
1102
1103 /* return a struct xpvlv to the free list */
1104
1105 STATIC void
1106 S_del_xpvlv(pTHX_ XPVLV *p)
1107 {
1108     LOCK_SV_MUTEX;
1109     p->xpv_pv = (char*)PL_xpvlv_root;
1110     PL_xpvlv_root = p;
1111     UNLOCK_SV_MUTEX;
1112 }
1113
1114 /* allocate another arena's worth of struct xpvlv */
1115
1116 STATIC void
1117 S_more_xpvlv(pTHX)
1118 {
1119     register XPVLV* xpvlv;
1120     register XPVLV* xpvlvend;
1121     New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1122     xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1123     PL_xpvlv_arenaroot = xpvlv;
1124
1125     xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1126     PL_xpvlv_root = ++xpvlv;
1127     while (xpvlv < xpvlvend) {
1128         xpvlv->xpv_pv = (char*)(xpvlv + 1);
1129         xpvlv++;
1130     }
1131     xpvlv->xpv_pv = 0;
1132 }
1133
1134 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1135
1136 STATIC XPVBM*
1137 S_new_xpvbm(pTHX)
1138 {
1139     XPVBM* xpvbm;
1140     LOCK_SV_MUTEX;
1141     if (!PL_xpvbm_root)
1142         more_xpvbm();
1143     xpvbm = PL_xpvbm_root;
1144     PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1145     UNLOCK_SV_MUTEX;
1146     return xpvbm;
1147 }
1148
1149 /* return a struct xpvbm to the free list */
1150
1151 STATIC void
1152 S_del_xpvbm(pTHX_ XPVBM *p)
1153 {
1154     LOCK_SV_MUTEX;
1155     p->xpv_pv = (char*)PL_xpvbm_root;
1156     PL_xpvbm_root = p;
1157     UNLOCK_SV_MUTEX;
1158 }
1159
1160 /* allocate another arena's worth of struct xpvbm */
1161
1162 STATIC void
1163 S_more_xpvbm(pTHX)
1164 {
1165     register XPVBM* xpvbm;
1166     register XPVBM* xpvbmend;
1167     New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1168     xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1169     PL_xpvbm_arenaroot = xpvbm;
1170
1171     xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1172     PL_xpvbm_root = ++xpvbm;
1173     while (xpvbm < xpvbmend) {
1174         xpvbm->xpv_pv = (char*)(xpvbm + 1);
1175         xpvbm++;
1176     }
1177     xpvbm->xpv_pv = 0;
1178 }
1179
1180 #define my_safemalloc(s)        (void*)safemalloc(s)
1181 #define my_safefree(p)  safefree((char*)p)
1182
1183 #ifdef PURIFY
1184
1185 #define new_XIV()       my_safemalloc(sizeof(XPVIV))
1186 #define del_XIV(p)      my_safefree(p)
1187
1188 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
1189 #define del_XNV(p)      my_safefree(p)
1190
1191 #define new_XRV()       my_safemalloc(sizeof(XRV))
1192 #define del_XRV(p)      my_safefree(p)
1193
1194 #define new_XPV()       my_safemalloc(sizeof(XPV))
1195 #define del_XPV(p)      my_safefree(p)
1196
1197 #define new_XPVIV()     my_safemalloc(sizeof(XPVIV))
1198 #define del_XPVIV(p)    my_safefree(p)
1199
1200 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
1201 #define del_XPVNV(p)    my_safefree(p)
1202
1203 #define new_XPVCV()     my_safemalloc(sizeof(XPVCV))
1204 #define del_XPVCV(p)    my_safefree(p)
1205
1206 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
1207 #define del_XPVAV(p)    my_safefree(p)
1208
1209 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
1210 #define del_XPVHV(p)    my_safefree(p)
1211
1212 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
1213 #define del_XPVMG(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_XIV()       (void*)new_xiv()
1224 #define del_XIV(p)      del_xiv((XPVIV*) p)
1225
1226 #define new_XNV()       (void*)new_xnv()
1227 #define del_XNV(p)      del_xnv((XPVNV*) p)
1228
1229 #define new_XRV()       (void*)new_xrv()
1230 #define del_XRV(p)      del_xrv((XRV*) p)
1231
1232 #define new_XPV()       (void*)new_xpv()
1233 #define del_XPV(p)      del_xpv((XPV *)p)
1234
1235 #define new_XPVIV()     (void*)new_xpviv()
1236 #define del_XPVIV(p)    del_xpviv((XPVIV *)p)
1237
1238 #define new_XPVNV()     (void*)new_xpvnv()
1239 #define del_XPVNV(p)    del_xpvnv((XPVNV *)p)
1240
1241 #define new_XPVCV()     (void*)new_xpvcv()
1242 #define del_XPVCV(p)    del_xpvcv((XPVCV *)p)
1243
1244 #define new_XPVAV()     (void*)new_xpvav()
1245 #define del_XPVAV(p)    del_xpvav((XPVAV *)p)
1246
1247 #define new_XPVHV()     (void*)new_xpvhv()
1248 #define del_XPVHV(p)    del_xpvhv((XPVHV *)p)
1249
1250 #define new_XPVMG()     (void*)new_xpvmg()
1251 #define del_XPVMG(p)    del_xpvmg((XPVMG *)p)
1252
1253 #define new_XPVLV()     (void*)new_xpvlv()
1254 #define del_XPVLV(p)    del_xpvlv((XPVLV *)p)
1255
1256 #define new_XPVBM()     (void*)new_xpvbm()
1257 #define del_XPVBM(p)    del_xpvbm((XPVBM *)p)
1258
1259 #endif /* PURIFY */
1260
1261 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
1262 #define del_XPVGV(p)    my_safefree(p)
1263
1264 #define new_XPVFM()     my_safemalloc(sizeof(XPVFM))
1265 #define del_XPVFM(p)    my_safefree(p)
1266
1267 #define new_XPVIO()     my_safemalloc(sizeof(XPVIO))
1268 #define del_XPVIO(p)    my_safefree(p)
1269
1270 /*
1271 =for apidoc sv_upgrade
1272
1273 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1274 SV, then copies across as much information as possible from the old body.
1275 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1276
1277 =cut
1278 */
1279
1280 bool
1281 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1282 {
1283     char*       pv = NULL;
1284     U32         cur = 0;
1285     U32         len = 0;
1286     IV          iv = 0;
1287     NV          nv = 0.0;
1288     MAGIC*      magic = NULL;
1289     HV*         stash = Nullhv;
1290
1291     if (mt != SVt_PV && SvIsCOW(sv)) {
1292         sv_force_normal_flags(sv, 0);
1293     }
1294
1295     if (SvTYPE(sv) == mt)
1296         return TRUE;
1297
1298     if (mt < SVt_PVIV)
1299         (void)SvOOK_off(sv);
1300
1301     switch (SvTYPE(sv)) {
1302     case SVt_NULL:
1303         pv      = 0;
1304         cur     = 0;
1305         len     = 0;
1306         iv      = 0;
1307         nv      = 0.0;
1308         magic   = 0;
1309         stash   = 0;
1310         break;
1311     case SVt_IV:
1312         pv      = 0;
1313         cur     = 0;
1314         len     = 0;
1315         iv      = SvIVX(sv);
1316         nv      = (NV)SvIVX(sv);
1317         del_XIV(SvANY(sv));
1318         magic   = 0;
1319         stash   = 0;
1320         if (mt == SVt_NV)
1321             mt = SVt_PVNV;
1322         else if (mt < SVt_PVIV)
1323             mt = SVt_PVIV;
1324         break;
1325     case SVt_NV:
1326         pv      = 0;
1327         cur     = 0;
1328         len     = 0;
1329         nv      = SvNVX(sv);
1330         iv      = I_V(nv);
1331         magic   = 0;
1332         stash   = 0;
1333         del_XNV(SvANY(sv));
1334         SvANY(sv) = 0;
1335         if (mt < SVt_PVNV)
1336             mt = SVt_PVNV;
1337         break;
1338     case SVt_RV:
1339         pv      = (char*)SvRV(sv);
1340         cur     = 0;
1341         len     = 0;
1342         iv      = PTR2IV(pv);
1343         nv      = PTR2NV(pv);
1344         del_XRV(SvANY(sv));
1345         magic   = 0;
1346         stash   = 0;
1347         break;
1348     case SVt_PV:
1349         pv      = SvPVX(sv);
1350         cur     = SvCUR(sv);
1351         len     = SvLEN(sv);
1352         iv      = 0;
1353         nv      = 0.0;
1354         magic   = 0;
1355         stash   = 0;
1356         del_XPV(SvANY(sv));
1357         if (mt <= SVt_IV)
1358             mt = SVt_PVIV;
1359         else if (mt == SVt_NV)
1360             mt = SVt_PVNV;
1361         break;
1362     case SVt_PVIV:
1363         pv      = SvPVX(sv);
1364         cur     = SvCUR(sv);
1365         len     = SvLEN(sv);
1366         iv      = SvIVX(sv);
1367         nv      = 0.0;
1368         magic   = 0;
1369         stash   = 0;
1370         del_XPVIV(SvANY(sv));
1371         break;
1372     case SVt_PVNV:
1373         pv      = SvPVX(sv);
1374         cur     = SvCUR(sv);
1375         len     = SvLEN(sv);
1376         iv      = SvIVX(sv);
1377         nv      = SvNVX(sv);
1378         magic   = 0;
1379         stash   = 0;
1380         del_XPVNV(SvANY(sv));
1381         break;
1382     case SVt_PVMG:
1383         pv      = SvPVX(sv);
1384         cur     = SvCUR(sv);
1385         len     = SvLEN(sv);
1386         iv      = SvIVX(sv);
1387         nv      = SvNVX(sv);
1388         magic   = SvMAGIC(sv);
1389         stash   = SvSTASH(sv);
1390         del_XPVMG(SvANY(sv));
1391         break;
1392     default:
1393         Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1394     }
1395
1396     switch (mt) {
1397     case SVt_NULL:
1398         Perl_croak(aTHX_ "Can't upgrade to undef");
1399     case SVt_IV:
1400         SvANY(sv) = new_XIV();
1401         SvIVX(sv)       = iv;
1402         break;
1403     case SVt_NV:
1404         SvANY(sv) = new_XNV();
1405         SvNVX(sv)       = nv;
1406         break;
1407     case SVt_RV:
1408         SvANY(sv) = new_XRV();
1409         SvRV(sv) = (SV*)pv;
1410         break;
1411     case SVt_PV:
1412         SvANY(sv) = new_XPV();
1413         SvPVX(sv)       = pv;
1414         SvCUR(sv)       = cur;
1415         SvLEN(sv)       = len;
1416         break;
1417     case SVt_PVIV:
1418         SvANY(sv) = new_XPVIV();
1419         SvPVX(sv)       = pv;
1420         SvCUR(sv)       = cur;
1421         SvLEN(sv)       = len;
1422         SvIVX(sv)       = iv;
1423         if (SvNIOK(sv))
1424             (void)SvIOK_on(sv);
1425         SvNOK_off(sv);
1426         break;
1427     case SVt_PVNV:
1428         SvANY(sv) = new_XPVNV();
1429         SvPVX(sv)       = pv;
1430         SvCUR(sv)       = cur;
1431         SvLEN(sv)       = len;
1432         SvIVX(sv)       = iv;
1433         SvNVX(sv)       = nv;
1434         break;
1435     case SVt_PVMG:
1436         SvANY(sv) = new_XPVMG();
1437         SvPVX(sv)       = pv;
1438         SvCUR(sv)       = cur;
1439         SvLEN(sv)       = len;
1440         SvIVX(sv)       = iv;
1441         SvNVX(sv)       = nv;
1442         SvMAGIC(sv)     = magic;
1443         SvSTASH(sv)     = stash;
1444         break;
1445     case SVt_PVLV:
1446         SvANY(sv) = new_XPVLV();
1447         SvPVX(sv)       = pv;
1448         SvCUR(sv)       = cur;
1449         SvLEN(sv)       = len;
1450         SvIVX(sv)       = iv;
1451         SvNVX(sv)       = nv;
1452         SvMAGIC(sv)     = magic;
1453         SvSTASH(sv)     = stash;
1454         LvTARGOFF(sv)   = 0;
1455         LvTARGLEN(sv)   = 0;
1456         LvTARG(sv)      = 0;
1457         LvTYPE(sv)      = 0;
1458         break;
1459     case SVt_PVAV:
1460         SvANY(sv) = new_XPVAV();
1461         if (pv)
1462             Safefree(pv);
1463         SvPVX(sv)       = 0;
1464         AvMAX(sv)       = -1;
1465         AvFILLp(sv)     = -1;
1466         SvIVX(sv)       = 0;
1467         SvNVX(sv)       = 0.0;
1468         SvMAGIC(sv)     = magic;
1469         SvSTASH(sv)     = stash;
1470         AvALLOC(sv)     = 0;
1471         AvARYLEN(sv)    = 0;
1472         AvFLAGS(sv)     = 0;
1473         break;
1474     case SVt_PVHV:
1475         SvANY(sv) = new_XPVHV();
1476         if (pv)
1477             Safefree(pv);
1478         SvPVX(sv)       = 0;
1479         HvFILL(sv)      = 0;
1480         HvMAX(sv)       = 0;
1481         HvTOTALKEYS(sv) = 0;
1482         HvPLACEHOLDERS(sv) = 0;
1483         SvMAGIC(sv)     = magic;
1484         SvSTASH(sv)     = stash;
1485         HvRITER(sv)     = 0;
1486         HvEITER(sv)     = 0;
1487         HvPMROOT(sv)    = 0;
1488         HvNAME(sv)      = 0;
1489         break;
1490     case SVt_PVCV:
1491         SvANY(sv) = new_XPVCV();
1492         Zero(SvANY(sv), 1, XPVCV);
1493         SvPVX(sv)       = pv;
1494         SvCUR(sv)       = cur;
1495         SvLEN(sv)       = len;
1496         SvIVX(sv)       = iv;
1497         SvNVX(sv)       = nv;
1498         SvMAGIC(sv)     = magic;
1499         SvSTASH(sv)     = stash;
1500         break;
1501     case SVt_PVGV:
1502         SvANY(sv) = new_XPVGV();
1503         SvPVX(sv)       = pv;
1504         SvCUR(sv)       = cur;
1505         SvLEN(sv)       = len;
1506         SvIVX(sv)       = iv;
1507         SvNVX(sv)       = nv;
1508         SvMAGIC(sv)     = magic;
1509         SvSTASH(sv)     = stash;
1510         GvGP(sv)        = 0;
1511         GvNAME(sv)      = 0;
1512         GvNAMELEN(sv)   = 0;
1513         GvSTASH(sv)     = 0;
1514         GvFLAGS(sv)     = 0;
1515         break;
1516     case SVt_PVBM:
1517         SvANY(sv) = new_XPVBM();
1518         SvPVX(sv)       = pv;
1519         SvCUR(sv)       = cur;
1520         SvLEN(sv)       = len;
1521         SvIVX(sv)       = iv;
1522         SvNVX(sv)       = nv;
1523         SvMAGIC(sv)     = magic;
1524         SvSTASH(sv)     = stash;
1525         BmRARE(sv)      = 0;
1526         BmUSEFUL(sv)    = 0;
1527         BmPREVIOUS(sv)  = 0;
1528         break;
1529     case SVt_PVFM:
1530         SvANY(sv) = new_XPVFM();
1531         Zero(SvANY(sv), 1, XPVFM);
1532         SvPVX(sv)       = pv;
1533         SvCUR(sv)       = cur;
1534         SvLEN(sv)       = len;
1535         SvIVX(sv)       = iv;
1536         SvNVX(sv)       = nv;
1537         SvMAGIC(sv)     = magic;
1538         SvSTASH(sv)     = stash;
1539         break;
1540     case SVt_PVIO:
1541         SvANY(sv) = new_XPVIO();
1542         Zero(SvANY(sv), 1, XPVIO);
1543         SvPVX(sv)       = pv;
1544         SvCUR(sv)       = cur;
1545         SvLEN(sv)       = len;
1546         SvIVX(sv)       = iv;
1547         SvNVX(sv)       = nv;
1548         SvMAGIC(sv)     = magic;
1549         SvSTASH(sv)     = stash;
1550         IoPAGE_LEN(sv)  = 60;
1551         break;
1552     }
1553     SvFLAGS(sv) &= ~SVTYPEMASK;
1554     SvFLAGS(sv) |= mt;
1555     return TRUE;
1556 }
1557
1558 /*
1559 =for apidoc sv_backoff
1560
1561 Remove any string offset. You should normally use the C<SvOOK_off> macro
1562 wrapper instead.
1563
1564 =cut
1565 */
1566
1567 int
1568 Perl_sv_backoff(pTHX_ register SV *sv)
1569 {
1570     assert(SvOOK(sv));
1571     if (SvIVX(sv)) {
1572         char *s = SvPVX(sv);
1573         SvLEN(sv) += SvIVX(sv);
1574         SvPVX(sv) -= SvIVX(sv);
1575         SvIV_set(sv, 0);
1576         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1577     }
1578     SvFLAGS(sv) &= ~SVf_OOK;
1579     return 0;
1580 }
1581
1582 /*
1583 =for apidoc sv_grow
1584
1585 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1586 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1587 Use the C<SvGROW> wrapper instead.
1588
1589 =cut
1590 */
1591
1592 char *
1593 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1594 {
1595     register char *s;
1596
1597 #ifdef HAS_64K_LIMIT
1598     if (newlen >= 0x10000) {
1599         PerlIO_printf(Perl_debug_log,
1600                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1601         my_exit(1);
1602     }
1603 #endif /* HAS_64K_LIMIT */
1604     if (SvROK(sv))
1605         sv_unref(sv);
1606     if (SvTYPE(sv) < SVt_PV) {
1607         sv_upgrade(sv, SVt_PV);
1608         s = SvPVX(sv);
1609     }
1610     else if (SvOOK(sv)) {       /* pv is offset? */
1611         sv_backoff(sv);
1612         s = SvPVX(sv);
1613         if (newlen > SvLEN(sv))
1614             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1615 #ifdef HAS_64K_LIMIT
1616         if (newlen >= 0x10000)
1617             newlen = 0xFFFF;
1618 #endif
1619     }
1620     else
1621         s = SvPVX(sv);
1622
1623     if (newlen > SvLEN(sv)) {           /* need more room? */
1624         if (SvLEN(sv) && s) {
1625 #ifdef MYMALLOC
1626             STRLEN l = malloced_size((void*)SvPVX(sv));
1627             if (newlen <= l) {
1628                 SvLEN_set(sv, l);
1629                 return s;
1630             } else
1631 #endif
1632             Renew(s,newlen,char);
1633         }
1634         else {
1635             New(703, s, newlen, char);
1636             if (SvPVX(sv) && SvCUR(sv)) {
1637                 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1638             }
1639         }
1640         SvPV_set(sv, s);
1641         SvLEN_set(sv, newlen);
1642     }
1643     return s;
1644 }
1645
1646 /*
1647 =for apidoc sv_setiv
1648
1649 Copies an integer into the given SV, upgrading first if necessary.
1650 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1651
1652 =cut
1653 */
1654
1655 void
1656 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1657 {
1658     SV_CHECK_THINKFIRST_COW_DROP(sv);
1659     switch (SvTYPE(sv)) {
1660     case SVt_NULL:
1661         sv_upgrade(sv, SVt_IV);
1662         break;
1663     case SVt_NV:
1664         sv_upgrade(sv, SVt_PVNV);
1665         break;
1666     case SVt_RV:
1667     case SVt_PV:
1668         sv_upgrade(sv, SVt_PVIV);
1669         break;
1670
1671     case SVt_PVGV:
1672     case SVt_PVAV:
1673     case SVt_PVHV:
1674     case SVt_PVCV:
1675     case SVt_PVFM:
1676     case SVt_PVIO:
1677         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1678                    OP_DESC(PL_op));
1679     }
1680     (void)SvIOK_only(sv);                       /* validate number */
1681     SvIVX(sv) = i;
1682     SvTAINT(sv);
1683 }
1684
1685 /*
1686 =for apidoc sv_setiv_mg
1687
1688 Like C<sv_setiv>, but also handles 'set' magic.
1689
1690 =cut
1691 */
1692
1693 void
1694 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1695 {
1696     sv_setiv(sv,i);
1697     SvSETMAGIC(sv);
1698 }
1699
1700 /*
1701 =for apidoc sv_setuv
1702
1703 Copies an unsigned integer into the given SV, upgrading first if necessary.
1704 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1705
1706 =cut
1707 */
1708
1709 void
1710 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1711 {
1712     /* With these two if statements:
1713        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1714
1715        without
1716        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1717
1718        If you wish to remove them, please benchmark to see what the effect is
1719     */
1720     if (u <= (UV)IV_MAX) {
1721        sv_setiv(sv, (IV)u);
1722        return;
1723     }
1724     sv_setiv(sv, 0);
1725     SvIsUV_on(sv);
1726     SvUVX(sv) = u;
1727 }
1728
1729 /*
1730 =for apidoc sv_setuv_mg
1731
1732 Like C<sv_setuv>, but also handles 'set' magic.
1733
1734 =cut
1735 */
1736
1737 void
1738 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1739 {
1740     /* With these two if statements:
1741        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1742
1743        without
1744        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1745
1746        If you wish to remove them, please benchmark to see what the effect is
1747     */
1748     if (u <= (UV)IV_MAX) {
1749        sv_setiv(sv, (IV)u);
1750     } else {
1751        sv_setiv(sv, 0);
1752        SvIsUV_on(sv);
1753        sv_setuv(sv,u);
1754     }
1755     SvSETMAGIC(sv);
1756 }
1757
1758 /*
1759 =for apidoc sv_setnv
1760
1761 Copies a double into the given SV, upgrading first if necessary.
1762 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1763
1764 =cut
1765 */
1766
1767 void
1768 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1769 {
1770     SV_CHECK_THINKFIRST_COW_DROP(sv);
1771     switch (SvTYPE(sv)) {
1772     case SVt_NULL:
1773     case SVt_IV:
1774         sv_upgrade(sv, SVt_NV);
1775         break;
1776     case SVt_RV:
1777     case SVt_PV:
1778     case SVt_PVIV:
1779         sv_upgrade(sv, SVt_PVNV);
1780         break;
1781
1782     case SVt_PVGV:
1783     case SVt_PVAV:
1784     case SVt_PVHV:
1785     case SVt_PVCV:
1786     case SVt_PVFM:
1787     case SVt_PVIO:
1788         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1789                    OP_NAME(PL_op));
1790     }
1791     SvNVX(sv) = num;
1792     (void)SvNOK_only(sv);                       /* validate number */
1793     SvTAINT(sv);
1794 }
1795
1796 /*
1797 =for apidoc sv_setnv_mg
1798
1799 Like C<sv_setnv>, but also handles 'set' magic.
1800
1801 =cut
1802 */
1803
1804 void
1805 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1806 {
1807     sv_setnv(sv,num);
1808     SvSETMAGIC(sv);
1809 }
1810
1811 /* Print an "isn't numeric" warning, using a cleaned-up,
1812  * printable version of the offending string
1813  */
1814
1815 STATIC void
1816 S_not_a_number(pTHX_ SV *sv)
1817 {
1818      SV *dsv;
1819      char tmpbuf[64];
1820      char *pv;
1821
1822      if (DO_UTF8(sv)) {
1823           dsv = sv_2mortal(newSVpv("", 0));
1824           pv = sv_uni_display(dsv, sv, 10, 0);
1825      } else {
1826           char *d = tmpbuf;
1827           char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1828           /* each *s can expand to 4 chars + "...\0",
1829              i.e. need room for 8 chars */
1830
1831           char *s, *end;
1832           for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1833                int ch = *s & 0xFF;
1834                if (ch & 128 && !isPRINT_LC(ch)) {
1835                     *d++ = 'M';
1836                     *d++ = '-';
1837                     ch &= 127;
1838                }
1839                if (ch == '\n') {
1840                     *d++ = '\\';
1841                     *d++ = 'n';
1842                }
1843                else if (ch == '\r') {
1844                     *d++ = '\\';
1845                     *d++ = 'r';
1846                }
1847                else if (ch == '\f') {
1848                     *d++ = '\\';
1849                     *d++ = 'f';
1850                }
1851                else if (ch == '\\') {
1852                     *d++ = '\\';
1853                     *d++ = '\\';
1854                }
1855                else if (ch == '\0') {
1856                     *d++ = '\\';
1857                     *d++ = '0';
1858                }
1859                else if (isPRINT_LC(ch))
1860                     *d++ = ch;
1861                else {
1862                     *d++ = '^';
1863                     *d++ = toCTRL(ch);
1864                }
1865           }
1866           if (s < end) {
1867                *d++ = '.';
1868                *d++ = '.';
1869                *d++ = '.';
1870           }
1871           *d = '\0';
1872           pv = tmpbuf;
1873     }
1874
1875     if (PL_op)
1876         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1877                     "Argument \"%s\" isn't numeric in %s", pv,
1878                     OP_DESC(PL_op));
1879     else
1880         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1881                     "Argument \"%s\" isn't numeric", pv);
1882 }
1883
1884 /*
1885 =for apidoc looks_like_number
1886
1887 Test if the content of an SV looks like a number (or is a number).
1888 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1889 non-numeric warning), even if your atof() doesn't grok them.
1890
1891 =cut
1892 */
1893
1894 I32
1895 Perl_looks_like_number(pTHX_ SV *sv)
1896 {
1897     register char *sbegin;
1898     STRLEN len;
1899
1900     if (SvPOK(sv)) {
1901         sbegin = SvPVX(sv);
1902         len = SvCUR(sv);
1903     }
1904     else if (SvPOKp(sv))
1905         sbegin = SvPV(sv, len);
1906     else
1907         return 1; /* Historic.  Wrong?  */
1908     return grok_number(sbegin, len, NULL);
1909 }
1910
1911 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1912    until proven guilty, assume that things are not that bad... */
1913
1914 /*
1915    NV_PRESERVES_UV:
1916
1917    As 64 bit platforms often have an NV that doesn't preserve all bits of
1918    an IV (an assumption perl has been based on to date) it becomes necessary
1919    to remove the assumption that the NV always carries enough precision to
1920    recreate the IV whenever needed, and that the NV is the canonical form.
1921    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1922    precision as a side effect of conversion (which would lead to insanity
1923    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1924    1) to distinguish between IV/UV/NV slots that have cached a valid
1925       conversion where precision was lost and IV/UV/NV slots that have a
1926       valid conversion which has lost no precision
1927    2) to ensure that if a numeric conversion to one form is requested that
1928       would lose precision, the precise conversion (or differently
1929       imprecise conversion) is also performed and cached, to prevent
1930       requests for different numeric formats on the same SV causing
1931       lossy conversion chains. (lossless conversion chains are perfectly
1932       acceptable (still))
1933
1934
1935    flags are used:
1936    SvIOKp is true if the IV slot contains a valid value
1937    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1938    SvNOKp is true if the NV slot contains a valid value
1939    SvNOK  is true only if the NV value is accurate
1940
1941    so
1942    while converting from PV to NV, check to see if converting that NV to an
1943    IV(or UV) would lose accuracy over a direct conversion from PV to
1944    IV(or UV). If it would, cache both conversions, return NV, but mark
1945    SV as IOK NOKp (ie not NOK).
1946
1947    While converting from PV to IV, check to see if converting that IV to an
1948    NV would lose accuracy over a direct conversion from PV to NV. If it
1949    would, cache both conversions, flag similarly.
1950
1951    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1952    correctly because if IV & NV were set NV *always* overruled.
1953    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1954    changes - now IV and NV together means that the two are interchangeable:
1955    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1956
1957    The benefit of this is that operations such as pp_add know that if
1958    SvIOK is true for both left and right operands, then integer addition
1959    can be used instead of floating point (for cases where the result won't
1960    overflow). Before, floating point was always used, which could lead to
1961    loss of precision compared with integer addition.
1962
1963    * making IV and NV equal status should make maths accurate on 64 bit
1964      platforms
1965    * may speed up maths somewhat if pp_add and friends start to use
1966      integers when possible instead of fp. (Hopefully the overhead in
1967      looking for SvIOK and checking for overflow will not outweigh the
1968      fp to integer speedup)
1969    * will slow down integer operations (callers of SvIV) on "inaccurate"
1970      values, as the change from SvIOK to SvIOKp will cause a call into
1971      sv_2iv each time rather than a macro access direct to the IV slot
1972    * should speed up number->string conversion on integers as IV is
1973      favoured when IV and NV are equally accurate
1974
1975    ####################################################################
1976    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1977    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1978    On the other hand, SvUOK is true iff UV.
1979    ####################################################################
1980
1981    Your mileage will vary depending your CPU's relative fp to integer
1982    performance ratio.
1983 */
1984
1985 #ifndef NV_PRESERVES_UV
1986 #  define IS_NUMBER_UNDERFLOW_IV 1
1987 #  define IS_NUMBER_UNDERFLOW_UV 2
1988 #  define IS_NUMBER_IV_AND_UV    2
1989 #  define IS_NUMBER_OVERFLOW_IV  4
1990 #  define IS_NUMBER_OVERFLOW_UV  5
1991
1992 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1993
1994 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1995 STATIC int
1996 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1997 {
1998     DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1999     if (SvNVX(sv) < (NV)IV_MIN) {
2000         (void)SvIOKp_on(sv);
2001         (void)SvNOK_on(sv);
2002         SvIVX(sv) = IV_MIN;
2003         return IS_NUMBER_UNDERFLOW_IV;
2004     }
2005     if (SvNVX(sv) > (NV)UV_MAX) {
2006         (void)SvIOKp_on(sv);
2007         (void)SvNOK_on(sv);
2008         SvIsUV_on(sv);
2009         SvUVX(sv) = UV_MAX;
2010         return IS_NUMBER_OVERFLOW_UV;
2011     }
2012     (void)SvIOKp_on(sv);
2013     (void)SvNOK_on(sv);
2014     /* Can't use strtol etc to convert this string.  (See truth table in
2015        sv_2iv  */
2016     if (SvNVX(sv) <= (UV)IV_MAX) {
2017         SvIVX(sv) = I_V(SvNVX(sv));
2018         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2019             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2020         } else {
2021             /* Integer is imprecise. NOK, IOKp */
2022         }
2023         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2024     }
2025     SvIsUV_on(sv);
2026     SvUVX(sv) = U_V(SvNVX(sv));
2027     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2028         if (SvUVX(sv) == UV_MAX) {
2029             /* As we know that NVs don't preserve UVs, UV_MAX cannot
2030                possibly be preserved by NV. Hence, it must be overflow.
2031                NOK, IOKp */
2032             return IS_NUMBER_OVERFLOW_UV;
2033         }
2034         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2035     } else {
2036         /* Integer is imprecise. NOK, IOKp */
2037     }
2038     return IS_NUMBER_OVERFLOW_IV;
2039 }
2040 #endif /* !NV_PRESERVES_UV*/
2041
2042 /*
2043 =for apidoc sv_2iv
2044
2045 Return the integer value of an SV, doing any necessary string conversion,
2046 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2047
2048 =cut
2049 */
2050
2051 IV
2052 Perl_sv_2iv(pTHX_ register SV *sv)
2053 {
2054     if (!sv)
2055         return 0;
2056     if (SvGMAGICAL(sv)) {
2057         mg_get(sv);
2058         if (SvIOKp(sv))
2059             return SvIVX(sv);
2060         if (SvNOKp(sv)) {
2061             return I_V(SvNVX(sv));
2062         }
2063         if (SvPOKp(sv) && SvLEN(sv))
2064             return asIV(sv);
2065         if (!SvROK(sv)) {
2066             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2067                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2068                     report_uninit();
2069             }
2070             return 0;
2071         }
2072     }
2073     if (SvTHINKFIRST(sv)) {
2074         if (SvROK(sv)) {
2075           SV* tmpstr;
2076           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2077                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2078               return SvIV(tmpstr);
2079           return PTR2IV(SvRV(sv));
2080         }
2081         if (SvIsCOW(sv)) {
2082             sv_force_normal_flags(sv, 0);
2083         }
2084         if (SvREADONLY(sv) && !SvOK(sv)) {
2085             if (ckWARN(WARN_UNINITIALIZED))
2086                 report_uninit();
2087             return 0;
2088         }
2089     }
2090     if (SvIOKp(sv)) {
2091         if (SvIsUV(sv)) {
2092             return (IV)(SvUVX(sv));
2093         }
2094         else {
2095             return SvIVX(sv);
2096         }
2097     }
2098     if (SvNOKp(sv)) {
2099         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2100          * without also getting a cached IV/UV from it at the same time
2101          * (ie PV->NV conversion should detect loss of accuracy and cache
2102          * IV or UV at same time to avoid this.  NWC */
2103
2104         if (SvTYPE(sv) == SVt_NV)
2105             sv_upgrade(sv, SVt_PVNV);
2106
2107         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2108         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2109            certainly cast into the IV range at IV_MAX, whereas the correct
2110            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2111            cases go to UV */
2112         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2113             SvIVX(sv) = I_V(SvNVX(sv));
2114             if (SvNVX(sv) == (NV) SvIVX(sv)
2115 #ifndef NV_PRESERVES_UV
2116                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2117                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2118                 /* Don't flag it as "accurately an integer" if the number
2119                    came from a (by definition imprecise) NV operation, and
2120                    we're outside the range of NV integer precision */
2121 #endif
2122                 ) {
2123                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2124                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2125                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2126                                       PTR2UV(sv),
2127                                       SvNVX(sv),
2128                                       SvIVX(sv)));
2129
2130             } else {
2131                 /* IV not precise.  No need to convert from PV, as NV
2132                    conversion would already have cached IV if it detected
2133                    that PV->IV would be better than PV->NV->IV
2134                    flags already correct - don't set public IOK.  */
2135                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2136                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2137                                       PTR2UV(sv),
2138                                       SvNVX(sv),
2139                                       SvIVX(sv)));
2140             }
2141             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2142                but the cast (NV)IV_MIN rounds to a the value less (more
2143                negative) than IV_MIN which happens to be equal to SvNVX ??
2144                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2145                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2146                (NV)UVX == NVX are both true, but the values differ. :-(
2147                Hopefully for 2s complement IV_MIN is something like
2148                0x8000000000000000 which will be exact. NWC */
2149         }
2150         else {
2151             SvUVX(sv) = U_V(SvNVX(sv));
2152             if (
2153                 (SvNVX(sv) == (NV) SvUVX(sv))
2154 #ifndef  NV_PRESERVES_UV
2155                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2156                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2157                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2158                 /* Don't flag it as "accurately an integer" if the number
2159                    came from a (by definition imprecise) NV operation, and
2160                    we're outside the range of NV integer precision */
2161 #endif
2162                 )
2163                 SvIOK_on(sv);
2164             SvIsUV_on(sv);
2165           ret_iv_max:
2166             DEBUG_c(PerlIO_printf(Perl_debug_log,
2167                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2168                                   PTR2UV(sv),
2169                                   SvUVX(sv),
2170                                   SvUVX(sv)));
2171             return (IV)SvUVX(sv);
2172         }
2173     }
2174     else if (SvPOKp(sv) && SvLEN(sv)) {
2175         UV value;
2176         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2177         /* We want to avoid a possible problem when we cache an IV which
2178            may be later translated to an NV, and the resulting NV is not
2179            the same as the direct translation of the initial string
2180            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2181            be careful to ensure that the value with the .456 is around if the
2182            NV value is requested in the future).
2183
2184            This means that if we cache such an IV, we need to cache the
2185            NV as well.  Moreover, we trade speed for space, and do not
2186            cache the NV if we are sure it's not needed.
2187          */
2188
2189         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2190         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2191              == IS_NUMBER_IN_UV) {
2192             /* It's definitely an integer, only upgrade to PVIV */
2193             if (SvTYPE(sv) < SVt_PVIV)
2194                 sv_upgrade(sv, SVt_PVIV);
2195             (void)SvIOK_on(sv);
2196         } else if (SvTYPE(sv) < SVt_PVNV)
2197             sv_upgrade(sv, SVt_PVNV);
2198
2199         /* If NV preserves UV then we only use the UV value if we know that
2200            we aren't going to call atof() below. If NVs don't preserve UVs
2201            then the value returned may have more precision than atof() will
2202            return, even though value isn't perfectly accurate.  */
2203         if ((numtype & (IS_NUMBER_IN_UV
2204 #ifdef NV_PRESERVES_UV
2205                         | IS_NUMBER_NOT_INT
2206 #endif
2207             )) == IS_NUMBER_IN_UV) {
2208             /* This won't turn off the public IOK flag if it was set above  */
2209             (void)SvIOKp_on(sv);
2210
2211             if (!(numtype & IS_NUMBER_NEG)) {
2212                 /* positive */;
2213                 if (value <= (UV)IV_MAX) {
2214                     SvIVX(sv) = (IV)value;
2215                 } else {
2216                     SvUVX(sv) = value;
2217                     SvIsUV_on(sv);
2218                 }
2219             } else {
2220                 /* 2s complement assumption  */
2221                 if (value <= (UV)IV_MIN) {
2222                     SvIVX(sv) = -(IV)value;
2223                 } else {
2224                     /* Too negative for an IV.  This is a double upgrade, but
2225                        I'm assuming it will be rare.  */
2226                     if (SvTYPE(sv) < SVt_PVNV)
2227                         sv_upgrade(sv, SVt_PVNV);
2228                     SvNOK_on(sv);
2229                     SvIOK_off(sv);
2230                     SvIOKp_on(sv);
2231                     SvNVX(sv) = -(NV)value;
2232                     SvIVX(sv) = IV_MIN;
2233                 }
2234             }
2235         }
2236         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2237            will be in the previous block to set the IV slot, and the next
2238            block to set the NV slot.  So no else here.  */
2239
2240         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2241             != IS_NUMBER_IN_UV) {
2242             /* It wasn't an (integer that doesn't overflow the UV). */
2243             SvNVX(sv) = Atof(SvPVX(sv));
2244
2245             if (! numtype && ckWARN(WARN_NUMERIC))
2246                 not_a_number(sv);
2247
2248 #if defined(USE_LONG_DOUBLE)
2249             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2250                                   PTR2UV(sv), SvNVX(sv)));
2251 #else
2252             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2253                                   PTR2UV(sv), SvNVX(sv)));
2254 #endif
2255
2256
2257 #ifdef NV_PRESERVES_UV
2258             (void)SvIOKp_on(sv);
2259             (void)SvNOK_on(sv);
2260             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2261                 SvIVX(sv) = I_V(SvNVX(sv));
2262                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2263                     SvIOK_on(sv);
2264                 } else {
2265                     /* Integer is imprecise. NOK, IOKp */
2266                 }
2267                 /* UV will not work better than IV */
2268             } else {
2269                 if (SvNVX(sv) > (NV)UV_MAX) {
2270                     SvIsUV_on(sv);
2271                     /* Integer is inaccurate. NOK, IOKp, is UV */
2272                     SvUVX(sv) = UV_MAX;
2273                     SvIsUV_on(sv);
2274                 } else {
2275                     SvUVX(sv) = U_V(SvNVX(sv));
2276                     /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2277                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2278                         SvIOK_on(sv);
2279                         SvIsUV_on(sv);
2280                     } else {
2281                         /* Integer is imprecise. NOK, IOKp, is UV */
2282                         SvIsUV_on(sv);
2283                     }
2284                 }
2285                 goto ret_iv_max;
2286             }
2287 #else /* NV_PRESERVES_UV */
2288             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2289                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2290                 /* The IV slot will have been set from value returned by
2291                    grok_number above.  The NV slot has just been set using
2292                    Atof.  */
2293                 SvNOK_on(sv);
2294                 assert (SvIOKp(sv));
2295             } else {
2296                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2297                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2298                     /* Small enough to preserve all bits. */
2299                     (void)SvIOKp_on(sv);
2300                     SvNOK_on(sv);
2301                     SvIVX(sv) = I_V(SvNVX(sv));
2302                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2303                         SvIOK_on(sv);
2304                     /* Assumption: first non-preserved integer is < IV_MAX,
2305                        this NV is in the preserved range, therefore: */
2306                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2307                           < (UV)IV_MAX)) {
2308                         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);
2309                     }
2310                 } else {
2311                     /* IN_UV NOT_INT
2312                          0      0       already failed to read UV.
2313                          0      1       already failed to read UV.
2314                          1      0       you won't get here in this case. IV/UV
2315                                         slot set, public IOK, Atof() unneeded.
2316                          1      1       already read UV.
2317                        so there's no point in sv_2iuv_non_preserve() attempting
2318                        to use atol, strtol, strtoul etc.  */
2319                     if (sv_2iuv_non_preserve (sv, numtype)
2320                         >= IS_NUMBER_OVERFLOW_IV)
2321                     goto ret_iv_max;
2322                 }
2323             }
2324 #endif /* NV_PRESERVES_UV */
2325         }
2326     } else  {
2327         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2328             report_uninit();
2329         if (SvTYPE(sv) < SVt_IV)
2330             /* Typically the caller expects that sv_any is not NULL now.  */
2331             sv_upgrade(sv, SVt_IV);
2332         return 0;
2333     }
2334     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2335         PTR2UV(sv),SvIVX(sv)));
2336     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2337 }
2338
2339 /*
2340 =for apidoc sv_2uv
2341
2342 Return the unsigned integer value of an SV, doing any necessary string
2343 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2344 macros.
2345
2346 =cut
2347 */
2348
2349 UV
2350 Perl_sv_2uv(pTHX_ register SV *sv)
2351 {
2352     if (!sv)
2353         return 0;
2354     if (SvGMAGICAL(sv)) {
2355         mg_get(sv);
2356         if (SvIOKp(sv))
2357             return SvUVX(sv);
2358         if (SvNOKp(sv))
2359             return U_V(SvNVX(sv));
2360         if (SvPOKp(sv) && SvLEN(sv))
2361             return asUV(sv);
2362         if (!SvROK(sv)) {
2363             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2364                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2365                     report_uninit();
2366             }
2367             return 0;
2368         }
2369     }
2370     if (SvTHINKFIRST(sv)) {
2371         if (SvROK(sv)) {
2372           SV* tmpstr;
2373           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2374                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2375               return SvUV(tmpstr);
2376           return PTR2UV(SvRV(sv));
2377         }
2378         if (SvIsCOW(sv)) {
2379             sv_force_normal_flags(sv, 0);
2380         }
2381         if (SvREADONLY(sv) && !SvOK(sv)) {
2382             if (ckWARN(WARN_UNINITIALIZED))
2383                 report_uninit();
2384             return 0;
2385         }
2386     }
2387     if (SvIOKp(sv)) {
2388         if (SvIsUV(sv)) {
2389             return SvUVX(sv);
2390         }
2391         else {
2392             return (UV)SvIVX(sv);
2393         }
2394     }
2395     if (SvNOKp(sv)) {
2396         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2397          * without also getting a cached IV/UV from it at the same time
2398          * (ie PV->NV conversion should detect loss of accuracy and cache
2399          * IV or UV at same time to avoid this. */
2400         /* IV-over-UV optimisation - choose to cache IV if possible */
2401
2402         if (SvTYPE(sv) == SVt_NV)
2403             sv_upgrade(sv, SVt_PVNV);
2404
2405         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2406         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2407             SvIVX(sv) = I_V(SvNVX(sv));
2408             if (SvNVX(sv) == (NV) SvIVX(sv)
2409 #ifndef NV_PRESERVES_UV
2410                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2411                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2412                 /* Don't flag it as "accurately an integer" if the number
2413                    came from a (by definition imprecise) NV operation, and
2414                    we're outside the range of NV integer precision */
2415 #endif
2416                 ) {
2417                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2418                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2419                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2420                                       PTR2UV(sv),
2421                                       SvNVX(sv),
2422                                       SvIVX(sv)));
2423
2424             } else {
2425                 /* IV not precise.  No need to convert from PV, as NV
2426                    conversion would already have cached IV if it detected
2427                    that PV->IV would be better than PV->NV->IV
2428                    flags already correct - don't set public IOK.  */
2429                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2430                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2431                                       PTR2UV(sv),
2432                                       SvNVX(sv),
2433                                       SvIVX(sv)));
2434             }
2435             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2436                but the cast (NV)IV_MIN rounds to a the value less (more
2437                negative) than IV_MIN which happens to be equal to SvNVX ??
2438                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2439                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2440                (NV)UVX == NVX are both true, but the values differ. :-(
2441                Hopefully for 2s complement IV_MIN is something like
2442                0x8000000000000000 which will be exact. NWC */
2443         }
2444         else {
2445             SvUVX(sv) = U_V(SvNVX(sv));
2446             if (
2447                 (SvNVX(sv) == (NV) SvUVX(sv))
2448 #ifndef  NV_PRESERVES_UV
2449                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2450                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2451                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2452                 /* Don't flag it as "accurately an integer" if the number
2453                    came from a (by definition imprecise) NV operation, and
2454                    we're outside the range of NV integer precision */
2455 #endif
2456                 )
2457                 SvIOK_on(sv);
2458             SvIsUV_on(sv);
2459             DEBUG_c(PerlIO_printf(Perl_debug_log,
2460                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2461                                   PTR2UV(sv),
2462                                   SvUVX(sv),
2463                                   SvUVX(sv)));
2464         }
2465     }
2466     else if (SvPOKp(sv) && SvLEN(sv)) {
2467         UV value;
2468         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2469
2470         /* We want to avoid a possible problem when we cache a UV which
2471            may be later translated to an NV, and the resulting NV is not
2472            the translation of the initial data.
2473
2474            This means that if we cache such a UV, we need to cache the
2475            NV as well.  Moreover, we trade speed for space, and do not
2476            cache the NV if not needed.
2477          */
2478
2479         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2480         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2481              == IS_NUMBER_IN_UV) {
2482             /* It's definitely an integer, only upgrade to PVIV */
2483             if (SvTYPE(sv) < SVt_PVIV)
2484                 sv_upgrade(sv, SVt_PVIV);
2485             (void)SvIOK_on(sv);
2486         } else if (SvTYPE(sv) < SVt_PVNV)
2487             sv_upgrade(sv, SVt_PVNV);
2488
2489         /* If NV preserves UV then we only use the UV value if we know that
2490            we aren't going to call atof() below. If NVs don't preserve UVs
2491            then the value returned may have more precision than atof() will
2492            return, even though it isn't accurate.  */
2493         if ((numtype & (IS_NUMBER_IN_UV
2494 #ifdef NV_PRESERVES_UV
2495                         | IS_NUMBER_NOT_INT
2496 #endif
2497             )) == IS_NUMBER_IN_UV) {
2498             /* This won't turn off the public IOK flag if it was set above  */
2499             (void)SvIOKp_on(sv);
2500
2501             if (!(numtype & IS_NUMBER_NEG)) {
2502                 /* positive */;
2503                 if (value <= (UV)IV_MAX) {
2504                     SvIVX(sv) = (IV)value;
2505                 } else {
2506                     /* it didn't overflow, and it was positive. */
2507                     SvUVX(sv) = value;
2508                     SvIsUV_on(sv);
2509                 }
2510             } else {
2511                 /* 2s complement assumption  */
2512                 if (value <= (UV)IV_MIN) {
2513                     SvIVX(sv) = -(IV)value;
2514                 } else {
2515                     /* Too negative for an IV.  This is a double upgrade, but
2516                        I'm assuming it will be rare.  */
2517                     if (SvTYPE(sv) < SVt_PVNV)
2518                         sv_upgrade(sv, SVt_PVNV);
2519                     SvNOK_on(sv);
2520                     SvIOK_off(sv);
2521                     SvIOKp_on(sv);
2522                     SvNVX(sv) = -(NV)value;
2523                     SvIVX(sv) = IV_MIN;
2524                 }
2525             }
2526         }
2527
2528         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2529             != IS_NUMBER_IN_UV) {
2530             /* It wasn't an integer, or it overflowed the UV. */
2531             SvNVX(sv) = Atof(SvPVX(sv));
2532
2533             if (! numtype && ckWARN(WARN_NUMERIC))
2534                     not_a_number(sv);
2535
2536 #if defined(USE_LONG_DOUBLE)
2537             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2538                                   PTR2UV(sv), SvNVX(sv)));
2539 #else
2540             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2541                                   PTR2UV(sv), SvNVX(sv)));
2542 #endif
2543
2544 #ifdef NV_PRESERVES_UV
2545             (void)SvIOKp_on(sv);
2546             (void)SvNOK_on(sv);
2547             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2548                 SvIVX(sv) = I_V(SvNVX(sv));
2549                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2550                     SvIOK_on(sv);
2551                 } else {
2552                     /* Integer is imprecise. NOK, IOKp */
2553                 }
2554                 /* UV will not work better than IV */
2555             } else {
2556                 if (SvNVX(sv) > (NV)UV_MAX) {
2557                     SvIsUV_on(sv);
2558                     /* Integer is inaccurate. NOK, IOKp, is UV */
2559                     SvUVX(sv) = UV_MAX;
2560                     SvIsUV_on(sv);
2561                 } else {
2562                     SvUVX(sv) = U_V(SvNVX(sv));
2563                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2564                        NV preservse UV so can do correct comparison.  */
2565                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2566                         SvIOK_on(sv);
2567                         SvIsUV_on(sv);
2568                     } else {
2569                         /* Integer is imprecise. NOK, IOKp, is UV */
2570                         SvIsUV_on(sv);
2571                     }
2572                 }
2573             }
2574 #else /* NV_PRESERVES_UV */
2575             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2576                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2577                 /* The UV slot will have been set from value returned by
2578                    grok_number above.  The NV slot has just been set using
2579                    Atof.  */
2580                 SvNOK_on(sv);
2581                 assert (SvIOKp(sv));
2582             } else {
2583                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2584                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2585                     /* Small enough to preserve all bits. */
2586                     (void)SvIOKp_on(sv);
2587                     SvNOK_on(sv);
2588                     SvIVX(sv) = I_V(SvNVX(sv));
2589                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2590                         SvIOK_on(sv);
2591                     /* Assumption: first non-preserved integer is < IV_MAX,
2592                        this NV is in the preserved range, therefore: */
2593                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2594                           < (UV)IV_MAX)) {
2595                         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);
2596                     }
2597                 } else
2598                     sv_2iuv_non_preserve (sv, numtype);
2599             }
2600 #endif /* NV_PRESERVES_UV */
2601         }
2602     }
2603     else  {
2604         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2605             if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2606                 report_uninit();
2607         }
2608         if (SvTYPE(sv) < SVt_IV)
2609             /* Typically the caller expects that sv_any is not NULL now.  */
2610             sv_upgrade(sv, SVt_IV);
2611         return 0;
2612     }
2613
2614     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2615                           PTR2UV(sv),SvUVX(sv)));
2616     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2617 }
2618
2619 /*
2620 =for apidoc sv_2nv
2621
2622 Return the num value of an SV, doing any necessary string or integer
2623 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2624 macros.
2625
2626 =cut
2627 */
2628
2629 NV
2630 Perl_sv_2nv(pTHX_ register SV *sv)
2631 {
2632     if (!sv)
2633         return 0.0;
2634     if (SvGMAGICAL(sv)) {
2635         mg_get(sv);
2636         if (SvNOKp(sv))
2637             return SvNVX(sv);
2638         if (SvPOKp(sv) && SvLEN(sv)) {
2639             if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2640                 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2641                 not_a_number(sv);
2642             return Atof(SvPVX(sv));
2643         }
2644         if (SvIOKp(sv)) {
2645             if (SvIsUV(sv))
2646                 return (NV)SvUVX(sv);
2647             else
2648                 return (NV)SvIVX(sv);
2649         }
2650         if (!SvROK(sv)) {
2651             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2652                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2653                     report_uninit();
2654             }
2655             return 0;
2656         }
2657     }
2658     if (SvTHINKFIRST(sv)) {
2659         if (SvROK(sv)) {
2660           SV* tmpstr;
2661           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2662                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2663               return SvNV(tmpstr);
2664           return PTR2NV(SvRV(sv));
2665         }
2666         if (SvIsCOW(sv)) {
2667             sv_force_normal_flags(sv, 0);
2668         }
2669         if (SvREADONLY(sv) && !SvOK(sv)) {
2670             if (ckWARN(WARN_UNINITIALIZED))
2671                 report_uninit();
2672             return 0.0;
2673         }
2674     }
2675     if (SvTYPE(sv) < SVt_NV) {
2676         if (SvTYPE(sv) == SVt_IV)
2677             sv_upgrade(sv, SVt_PVNV);
2678         else
2679             sv_upgrade(sv, SVt_NV);
2680 #ifdef USE_LONG_DOUBLE
2681         DEBUG_c({
2682             STORE_NUMERIC_LOCAL_SET_STANDARD();
2683             PerlIO_printf(Perl_debug_log,
2684                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2685                           PTR2UV(sv), SvNVX(sv));
2686             RESTORE_NUMERIC_LOCAL();
2687         });
2688 #else
2689         DEBUG_c({
2690             STORE_NUMERIC_LOCAL_SET_STANDARD();
2691             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2692                           PTR2UV(sv), SvNVX(sv));
2693             RESTORE_NUMERIC_LOCAL();
2694         });
2695 #endif
2696     }
2697     else if (SvTYPE(sv) < SVt_PVNV)
2698         sv_upgrade(sv, SVt_PVNV);
2699     if (SvNOKp(sv)) {
2700         return SvNVX(sv);
2701     }
2702     if (SvIOKp(sv)) {
2703         SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2704 #ifdef NV_PRESERVES_UV
2705         SvNOK_on(sv);
2706 #else
2707         /* Only set the public NV OK flag if this NV preserves the IV  */
2708         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2709         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2710                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2711             SvNOK_on(sv);
2712         else
2713             SvNOKp_on(sv);
2714 #endif
2715     }
2716     else if (SvPOKp(sv) && SvLEN(sv)) {
2717         UV value;
2718         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2719         if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2720             not_a_number(sv);
2721 #ifdef NV_PRESERVES_UV
2722         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2723             == IS_NUMBER_IN_UV) {
2724             /* It's definitely an integer */
2725             SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2726         } else
2727             SvNVX(sv) = Atof(SvPVX(sv));
2728         SvNOK_on(sv);
2729 #else
2730         SvNVX(sv) = Atof(SvPVX(sv));
2731         /* Only set the public NV OK flag if this NV preserves the value in
2732            the PV at least as well as an IV/UV would.
2733            Not sure how to do this 100% reliably. */
2734         /* if that shift count is out of range then Configure's test is
2735            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2736            UV_BITS */
2737         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2738             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2739             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2740         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2741             /* Can't use strtol etc to convert this string, so don't try.
2742                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2743             SvNOK_on(sv);
2744         } else {
2745             /* value has been set.  It may not be precise.  */
2746             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2747                 /* 2s complement assumption for (UV)IV_MIN  */
2748                 SvNOK_on(sv); /* Integer is too negative.  */
2749             } else {
2750                 SvNOKp_on(sv);
2751                 SvIOKp_on(sv);
2752
2753                 if (numtype & IS_NUMBER_NEG) {
2754                     SvIVX(sv) = -(IV)value;
2755                 } else if (value <= (UV)IV_MAX) {
2756                     SvIVX(sv) = (IV)value;
2757                 } else {
2758                     SvUVX(sv) = value;
2759                     SvIsUV_on(sv);
2760                 }
2761
2762                 if (numtype & IS_NUMBER_NOT_INT) {
2763                     /* I believe that even if the original PV had decimals,
2764                        they are lost beyond the limit of the FP precision.
2765                        However, neither is canonical, so both only get p
2766                        flags.  NWC, 2000/11/25 */
2767                     /* Both already have p flags, so do nothing */
2768                 } else {
2769                     NV nv = SvNVX(sv);
2770                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2771                         if (SvIVX(sv) == I_V(nv)) {
2772                             SvNOK_on(sv);
2773                             SvIOK_on(sv);
2774                         } else {
2775                             SvIOK_on(sv);
2776                             /* It had no "." so it must be integer.  */
2777                         }
2778                     } else {
2779                         /* between IV_MAX and NV(UV_MAX).
2780                            Could be slightly > UV_MAX */
2781
2782                         if (numtype & IS_NUMBER_NOT_INT) {
2783                             /* UV and NV both imprecise.  */
2784                         } else {
2785                             UV nv_as_uv = U_V(nv);
2786
2787                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2788                                 SvNOK_on(sv);
2789                                 SvIOK_on(sv);
2790                             } else {
2791                                 SvIOK_on(sv);
2792                             }
2793                         }
2794                     }
2795                 }
2796             }
2797         }
2798 #endif /* NV_PRESERVES_UV */
2799     }
2800     else  {
2801         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2802             report_uninit();
2803         if (SvTYPE(sv) < SVt_NV)
2804             /* Typically the caller expects that sv_any is not NULL now.  */
2805             /* XXX Ilya implies that this is a bug in callers that assume this
2806                and ideally should be fixed.  */
2807             sv_upgrade(sv, SVt_NV);
2808         return 0.0;
2809     }
2810 #if defined(USE_LONG_DOUBLE)
2811     DEBUG_c({
2812         STORE_NUMERIC_LOCAL_SET_STANDARD();
2813         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2814                       PTR2UV(sv), SvNVX(sv));
2815         RESTORE_NUMERIC_LOCAL();
2816     });
2817 #else
2818     DEBUG_c({
2819         STORE_NUMERIC_LOCAL_SET_STANDARD();
2820         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2821                       PTR2UV(sv), SvNVX(sv));
2822         RESTORE_NUMERIC_LOCAL();
2823     });
2824 #endif
2825     return SvNVX(sv);
2826 }
2827
2828 /* asIV(): extract an integer from the string value of an SV.
2829  * Caller must validate PVX  */
2830
2831 STATIC IV
2832 S_asIV(pTHX_ SV *sv)
2833 {
2834     UV value;
2835     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2836
2837     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2838         == IS_NUMBER_IN_UV) {
2839         /* It's definitely an integer */
2840         if (numtype & IS_NUMBER_NEG) {
2841             if (value < (UV)IV_MIN)
2842                 return -(IV)value;
2843         } else {
2844             if (value < (UV)IV_MAX)
2845                 return (IV)value;
2846         }
2847     }
2848     if (!numtype) {
2849         if (ckWARN(WARN_NUMERIC))
2850             not_a_number(sv);
2851     }
2852     return I_V(Atof(SvPVX(sv)));
2853 }
2854
2855 /* asUV(): extract an unsigned integer from the string value of an SV
2856  * Caller must validate PVX  */
2857
2858 STATIC UV
2859 S_asUV(pTHX_ SV *sv)
2860 {
2861     UV value;
2862     int numtype = grok_number(SvPVX(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             return value;
2869     }
2870     if (!numtype) {
2871         if (ckWARN(WARN_NUMERIC))
2872             not_a_number(sv);
2873     }
2874     return U_V(Atof(SvPVX(sv)));
2875 }
2876
2877 /*
2878 =for apidoc sv_2pv_nolen
2879
2880 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2881 use the macro wrapper C<SvPV_nolen(sv)> instead.
2882 =cut
2883 */
2884
2885 char *
2886 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2887 {
2888     STRLEN n_a;
2889     return sv_2pv(sv, &n_a);
2890 }
2891
2892 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2893  * UV as a string towards the end of buf, and return pointers to start and
2894  * end of it.
2895  *
2896  * We assume that buf is at least TYPE_CHARS(UV) long.
2897  */
2898
2899 static char *
2900 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2901 {
2902     char *ptr = buf + TYPE_CHARS(UV);
2903     char *ebuf = ptr;
2904     int sign;
2905
2906     if (is_uv)
2907         sign = 0;
2908     else if (iv >= 0) {
2909         uv = iv;
2910         sign = 0;
2911     } else {
2912         uv = -iv;
2913         sign = 1;
2914     }
2915     do {
2916         *--ptr = '0' + (char)(uv % 10);
2917     } while (uv /= 10);
2918     if (sign)
2919         *--ptr = '-';
2920     *peob = ebuf;
2921     return ptr;
2922 }
2923
2924 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2925  * this function provided for binary compatibility only
2926  */
2927
2928 char *
2929 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2930 {
2931     return sv_2pv_flags(sv, lp, SV_GMAGIC);
2932 }
2933
2934 /*
2935 =for apidoc sv_2pv_flags
2936
2937 Returns a pointer to the string value of an SV, and sets *lp to its length.
2938 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2939 if necessary.
2940 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2941 usually end up here too.
2942
2943 =cut
2944 */
2945
2946 char *
2947 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2948 {
2949     register char *s;
2950     int olderrno;
2951     SV *tsv, *origsv;
2952     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
2953     char *tmpbuf = tbuf;
2954
2955     if (!sv) {
2956         *lp = 0;
2957         return "";
2958     }
2959     if (SvGMAGICAL(sv)) {
2960         if (flags & SV_GMAGIC)
2961             mg_get(sv);
2962         if (SvPOKp(sv)) {
2963             *lp = SvCUR(sv);
2964             return SvPVX(sv);
2965         }
2966         if (SvIOKp(sv)) {
2967             if (SvIsUV(sv))
2968                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2969             else
2970                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2971             tsv = Nullsv;
2972             goto tokensave;
2973         }
2974         if (SvNOKp(sv)) {
2975             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2976             tsv = Nullsv;
2977             goto tokensave;
2978         }
2979         if (!SvROK(sv)) {
2980             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2981                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2982                     report_uninit();
2983             }
2984             *lp = 0;
2985             return "";
2986         }
2987     }
2988     if (SvTHINKFIRST(sv)) {
2989         if (SvROK(sv)) {
2990             SV* tmpstr;
2991             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2992                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2993                 char *pv = SvPV(tmpstr, *lp);
2994                 if (SvUTF8(tmpstr))
2995                     SvUTF8_on(sv);
2996                 else
2997                     SvUTF8_off(sv);
2998                 return pv;
2999             }
3000             origsv = sv;
3001             sv = (SV*)SvRV(sv);
3002             if (!sv)
3003                 s = "NULLREF";
3004             else {
3005                 MAGIC *mg;
3006
3007                 switch (SvTYPE(sv)) {
3008                 case SVt_PVMG:
3009                     if ( ((SvFLAGS(sv) &
3010                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3011                           == (SVs_OBJECT|SVs_SMG))
3012                          && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3013                         regexp *re = (regexp *)mg->mg_obj;
3014
3015                         if (!mg->mg_ptr) {
3016                             char *fptr = "msix";
3017                             char reflags[6];
3018                             char ch;
3019                             int left = 0;
3020                             int right = 4;
3021                             char need_newline = 0;
3022                             U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3023
3024                             while((ch = *fptr++)) {
3025                                 if(reganch & 1) {
3026                                     reflags[left++] = ch;
3027                                 }
3028                                 else {
3029                                     reflags[right--] = ch;
3030                                 }
3031                                 reganch >>= 1;
3032                             }
3033                             if(left != 4) {
3034                                 reflags[left] = '-';
3035                                 left = 5;
3036                             }
3037
3038                             mg->mg_len = re->prelen + 4 + left;
3039                             /*
3040                              * If /x was used, we have to worry about a regex
3041                              * ending with a comment later being embedded
3042                              * within another regex. If so, we don't want this
3043                              * regex's "commentization" to leak out to the
3044                              * right part of the enclosing regex, we must cap
3045                              * it with a newline.
3046                              *
3047                              * So, if /x was used, we scan backwards from the
3048                              * end of the regex. If we find a '#' before we
3049                              * find a newline, we need to add a newline
3050                              * ourself. If we find a '\n' first (or if we
3051                              * don't find '#' or '\n'), we don't need to add
3052                              * anything.  -jfriedl
3053                              */
3054                             if (PMf_EXTENDED & re->reganch)
3055                             {
3056                                 char *endptr = re->precomp + re->prelen;
3057                                 while (endptr >= re->precomp)
3058                                 {
3059                                     char c = *(endptr--);
3060                                     if (c == '\n')
3061                                         break; /* don't need another */
3062                                     if (c == '#') {
3063                                         /* we end while in a comment, so we
3064                                            need a newline */
3065                                         mg->mg_len++; /* save space for it */
3066                                         need_newline = 1; /* note to add it */
3067                                         break;
3068                                     }
3069                                 }
3070                             }
3071
3072                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3073                             Copy("(?", mg->mg_ptr, 2, char);
3074                             Copy(reflags, mg->mg_ptr+2, left, char);
3075                             Copy(":", mg->mg_ptr+left+2, 1, char);
3076                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3077                             if (need_newline)
3078                                 mg->mg_ptr[mg->mg_len - 2] = '\n';
3079                             mg->mg_ptr[mg->mg_len - 1] = ')';
3080                             mg->mg_ptr[mg->mg_len] = 0;
3081                         }
3082                         PL_reginterp_cnt += re->program[0].next_off;
3083
3084                         if (re->reganch & ROPT_UTF8)
3085                             SvUTF8_on(origsv);
3086                         else
3087                             SvUTF8_off(origsv);
3088                         *lp = mg->mg_len;
3089                         return mg->mg_ptr;
3090                     }
3091                                         /* Fall through */
3092                 case SVt_NULL:
3093                 case SVt_IV:
3094                 case SVt_NV:
3095                 case SVt_RV:
3096                 case SVt_PV:
3097                 case SVt_PVIV:
3098                 case SVt_PVNV:
3099                 case SVt_PVBM:  if (SvROK(sv))
3100                                     s = "REF";
3101                                 else
3102                                     s = "SCALAR";               break;
3103                 case SVt_PVLV:  s = SvROK(sv) ? "REF"
3104                                 /* tied lvalues should appear to be
3105                                  * scalars for backwards compatitbility */
3106                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3107                                     ? "SCALAR" : "LVALUE";      break;
3108                 case SVt_PVAV:  s = "ARRAY";                    break;
3109                 case SVt_PVHV:  s = "HASH";                     break;
3110                 case SVt_PVCV:  s = "CODE";                     break;
3111                 case SVt_PVGV:  s = "GLOB";                     break;
3112                 case SVt_PVFM:  s = "FORMAT";                   break;
3113                 case SVt_PVIO:  s = "IO";                       break;
3114                 default:        s = "UNKNOWN";                  break;
3115                 }
3116                 tsv = NEWSV(0,0);
3117                 if (SvOBJECT(sv))
3118                     if (HvNAME(SvSTASH(sv)))
3119                         Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3120                     else
3121                         Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3122                 else
3123                     sv_setpv(tsv, s);
3124                 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3125                 goto tokensaveref;
3126             }
3127             *lp = strlen(s);
3128             return s;
3129         }
3130         if (SvREADONLY(sv) && !SvOK(sv)) {
3131             if (ckWARN(WARN_UNINITIALIZED))
3132                 report_uninit();
3133             *lp = 0;
3134             return "";
3135         }
3136     }
3137     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3138         /* I'm assuming that if both IV and NV are equally valid then
3139            converting the IV is going to be more efficient */
3140         U32 isIOK = SvIOK(sv);
3141         U32 isUIOK = SvIsUV(sv);
3142         char buf[TYPE_CHARS(UV)];
3143         char *ebuf, *ptr;
3144
3145         if (SvTYPE(sv) < SVt_PVIV)
3146             sv_upgrade(sv, SVt_PVIV);
3147         if (isUIOK)
3148             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3149         else
3150             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3151         SvGROW(sv, (STRLEN)(ebuf - ptr + 1));   /* inlined from sv_setpvn */
3152         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3153         SvCUR_set(sv, ebuf - ptr);
3154         s = SvEND(sv);
3155         *s = '\0';
3156         if (isIOK)
3157             SvIOK_on(sv);
3158         else
3159             SvIOKp_on(sv);
3160         if (isUIOK)
3161             SvIsUV_on(sv);
3162     }
3163     else if (SvNOKp(sv)) {
3164         if (SvTYPE(sv) < SVt_PVNV)
3165             sv_upgrade(sv, SVt_PVNV);
3166         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3167         SvGROW(sv, NV_DIG + 20);
3168         s = SvPVX(sv);
3169         olderrno = errno;       /* some Xenix systems wipe out errno here */
3170 #ifdef apollo
3171         if (SvNVX(sv) == 0.0)
3172             (void)strcpy(s,"0");
3173         else
3174 #endif /*apollo*/
3175         {
3176             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3177         }
3178         errno = olderrno;
3179 #ifdef FIXNEGATIVEZERO
3180         if (*s == '-' && s[1] == '0' && !s[2])
3181             strcpy(s,"0");
3182 #endif
3183         while (*s) s++;
3184 #ifdef hcx
3185         if (s[-1] == '.')
3186             *--s = '\0';
3187 #endif
3188     }
3189     else {
3190         if (ckWARN(WARN_UNINITIALIZED)
3191             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3192             report_uninit();
3193         *lp = 0;
3194         if (SvTYPE(sv) < SVt_PV)
3195             /* Typically the caller expects that sv_any is not NULL now.  */
3196             sv_upgrade(sv, SVt_PV);
3197         return "";
3198     }
3199     *lp = s - SvPVX(sv);
3200     SvCUR_set(sv, *lp);
3201     SvPOK_on(sv);
3202     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3203                           PTR2UV(sv),SvPVX(sv)));
3204     return SvPVX(sv);
3205
3206   tokensave:
3207     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3208         /* Sneaky stuff here */
3209
3210       tokensaveref:
3211         if (!tsv)
3212             tsv = newSVpv(tmpbuf, 0);
3213         sv_2mortal(tsv);
3214         *lp = SvCUR(tsv);
3215         return SvPVX(tsv);
3216     }
3217     else {
3218         STRLEN len;
3219         char *t;
3220
3221         if (tsv) {
3222             sv_2mortal(tsv);
3223             t = SvPVX(tsv);
3224             len = SvCUR(tsv);
3225         }
3226         else {
3227             t = tmpbuf;
3228             len = strlen(tmpbuf);
3229         }
3230 #ifdef FIXNEGATIVEZERO
3231         if (len == 2 && t[0] == '-' && t[1] == '0') {
3232             t = "0";
3233             len = 1;
3234         }
3235 #endif
3236         (void)SvUPGRADE(sv, SVt_PV);
3237         *lp = len;
3238         s = SvGROW(sv, len + 1);
3239         SvCUR_set(sv, len);
3240         (void)strcpy(s, t);
3241         SvPOKp_on(sv);
3242         return s;
3243     }
3244 }
3245
3246 /*
3247 =for apidoc sv_copypv
3248
3249 Copies a stringified representation of the source SV into the
3250 destination SV.  Automatically performs any necessary mg_get and
3251 coercion of numeric values into strings.  Guaranteed to preserve
3252 UTF-8 flag even from overloaded objects.  Similar in nature to
3253 sv_2pv[_flags] but operates directly on an SV instead of just the
3254 string.  Mostly uses sv_2pv_flags to do its work, except when that
3255 would lose the UTF-8'ness of the PV.
3256
3257 =cut
3258 */
3259
3260 void
3261 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3262 {
3263     STRLEN len;
3264     char *s;
3265     s = SvPV(ssv,len);
3266     sv_setpvn(dsv,s,len);
3267     if (SvUTF8(ssv))
3268         SvUTF8_on(dsv);
3269     else
3270         SvUTF8_off(dsv);
3271 }
3272
3273 /*
3274 =for apidoc sv_2pvbyte_nolen
3275
3276 Return a pointer to the byte-encoded representation of the SV.
3277 May cause the SV to be downgraded from UTF-8 as a side-effect.
3278
3279 Usually accessed via the C<SvPVbyte_nolen> macro.
3280
3281 =cut
3282 */
3283
3284 char *
3285 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3286 {
3287     STRLEN n_a;
3288     return sv_2pvbyte(sv, &n_a);
3289 }
3290
3291 /*
3292 =for apidoc sv_2pvbyte
3293
3294 Return a pointer to the byte-encoded representation of the SV, and set *lp
3295 to its length.  May cause the SV to be downgraded from UTF-8 as a
3296 side-effect.
3297
3298 Usually accessed via the C<SvPVbyte> macro.
3299
3300 =cut
3301 */
3302
3303 char *
3304 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3305 {
3306     sv_utf8_downgrade(sv,0);
3307     return SvPV(sv,*lp);
3308 }
3309
3310 /*
3311 =for apidoc sv_2pvutf8_nolen
3312
3313 Return a pointer to the UTF-8-encoded representation of the SV.
3314 May cause the SV to be upgraded to UTF-8 as a side-effect.
3315
3316 Usually accessed via the C<SvPVutf8_nolen> macro.
3317
3318 =cut
3319 */
3320
3321 char *
3322 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3323 {
3324     STRLEN n_a;
3325     return sv_2pvutf8(sv, &n_a);
3326 }
3327
3328 /*
3329 =for apidoc sv_2pvutf8
3330
3331 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3332 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3333
3334 Usually accessed via the C<SvPVutf8> macro.
3335
3336 =cut
3337 */
3338
3339 char *
3340 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3341 {
3342     sv_utf8_upgrade(sv);
3343     return SvPV(sv,*lp);
3344 }
3345
3346 /*
3347 =for apidoc sv_2bool
3348
3349 This function is only called on magical items, and is only used by
3350 sv_true() or its macro equivalent.
3351
3352 =cut
3353 */
3354
3355 bool
3356 Perl_sv_2bool(pTHX_ register SV *sv)
3357 {
3358     if (SvGMAGICAL(sv))
3359         mg_get(sv);
3360
3361     if (!SvOK(sv))
3362         return 0;
3363     if (SvROK(sv)) {
3364         SV* tmpsv;
3365         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3366                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3367             return (bool)SvTRUE(tmpsv);
3368       return SvRV(sv) != 0;
3369     }
3370     if (SvPOKp(sv)) {
3371         register XPV* Xpvtmp;
3372         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3373                 (*Xpvtmp->xpv_pv > '0' ||
3374                 Xpvtmp->xpv_cur > 1 ||
3375                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3376             return 1;
3377         else
3378             return 0;
3379     }
3380     else {
3381         if (SvIOKp(sv))
3382             return SvIVX(sv) != 0;
3383         else {
3384             if (SvNOKp(sv))
3385                 return SvNVX(sv) != 0.0;
3386             else
3387                 return FALSE;
3388         }
3389     }
3390 }
3391
3392 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3393  * this function provided for binary compatibility only
3394  */
3395
3396
3397 STRLEN
3398 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3399 {
3400     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3401 }
3402
3403 /*
3404 =for apidoc sv_utf8_upgrade
3405
3406 Convert the PV of an SV to its UTF-8-encoded form.
3407 Forces the SV to string form if it is not already.
3408 Always sets the SvUTF8 flag to avoid future validity checks even
3409 if all the bytes have hibit clear.
3410
3411 This is not as a general purpose byte encoding to Unicode interface:
3412 use the Encode extension for that.
3413
3414 =for apidoc sv_utf8_upgrade_flags
3415
3416 Convert the PV of an SV to its UTF-8-encoded form.
3417 Forces the SV to string form if it is not already.
3418 Always sets the SvUTF8 flag to avoid future validity checks even
3419 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3420 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3421 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3422
3423 This is not as a general purpose byte encoding to Unicode interface:
3424 use the Encode extension for that.
3425
3426 =cut
3427 */
3428
3429 STRLEN
3430 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3431 {
3432     U8 *s, *t, *e;
3433     int  hibit = 0;
3434
3435     if (!sv)
3436         return 0;
3437
3438     if (!SvPOK(sv)) {
3439         STRLEN len = 0;
3440         (void) sv_2pv_flags(sv,&len, flags);
3441         if (!SvPOK(sv))
3442              return len;
3443     }
3444
3445     if (SvUTF8(sv))
3446         return SvCUR(sv);
3447
3448     if (SvIsCOW(sv)) {
3449         sv_force_normal_flags(sv, 0);
3450     }
3451
3452     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3453         sv_recode_to_utf8(sv, PL_encoding);
3454     else { /* Assume Latin-1/EBCDIC */
3455          /* This function could be much more efficient if we
3456           * had a FLAG in SVs to signal if there are any hibit
3457           * chars in the PV.  Given that there isn't such a flag
3458           * make the loop as fast as possible. */
3459          s = (U8 *) SvPVX(sv);
3460          e = (U8 *) SvEND(sv);
3461          t = s;
3462          while (t < e) {
3463               U8 ch = *t++;
3464               if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3465                    break;
3466          }
3467          if (hibit) {
3468               STRLEN len;
3469
3470               len = SvCUR(sv) + 1; /* Plus the \0 */
3471               SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3472               SvCUR(sv) = len - 1;
3473               if (SvLEN(sv) != 0)
3474                    Safefree(s); /* No longer using what was there before. */
3475               SvLEN(sv) = len; /* No longer know the real size. */
3476          }
3477          /* Mark as UTF-8 even if no hibit - saves scanning loop */
3478          SvUTF8_on(sv);
3479     }
3480     return SvCUR(sv);
3481 }
3482
3483 /*
3484 =for apidoc sv_utf8_downgrade
3485
3486 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
3487 This may not be possible if the PV contains non-byte encoding characters;
3488 if this is the case, either returns false or, if C<fail_ok> is not
3489 true, croaks.
3490
3491 This is not as a general purpose Unicode to byte encoding interface:
3492 use the Encode extension for that.
3493
3494 =cut
3495 */
3496
3497 bool
3498 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3499 {
3500     if (SvPOK(sv) && SvUTF8(sv)) {
3501         if (SvCUR(sv)) {
3502             U8 *s;
3503             STRLEN len;
3504
3505             if (SvIsCOW(sv)) {
3506                 sv_force_normal_flags(sv, 0);
3507             }
3508             s = (U8 *) SvPV(sv, len);
3509             if (!utf8_to_bytes(s, &len)) {
3510                 if (fail_ok)
3511                     return FALSE;
3512                 else {
3513                     if (PL_op)
3514                         Perl_croak(aTHX_ "Wide character in %s",
3515                                    OP_DESC(PL_op));
3516                     else
3517                         Perl_croak(aTHX_ "Wide character");
3518                 }
3519             }
3520             SvCUR(sv) = len;
3521         }
3522     }
3523     SvUTF8_off(sv);
3524     return TRUE;
3525 }
3526
3527 /*
3528 =for apidoc sv_utf8_encode
3529
3530 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
3531 flag so that it looks like octets again. Used as a building block
3532 for encode_utf8 in Encode.xs
3533
3534 =cut
3535 */
3536
3537 void
3538 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3539 {
3540     (void) sv_utf8_upgrade(sv);
3541     SvUTF8_off(sv);
3542 }
3543
3544 /*
3545 =for apidoc sv_utf8_decode
3546
3547 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3548 turn off SvUTF8 if needed so that we see characters. Used as a building block
3549 for decode_utf8 in Encode.xs
3550
3551 =cut
3552 */
3553
3554 bool
3555 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3556 {
3557     if (SvPOK(sv)) {
3558         U8 *c;
3559         U8 *e;
3560
3561         /* The octets may have got themselves encoded - get them back as
3562          * bytes
3563          */
3564         if (!sv_utf8_downgrade(sv, TRUE))
3565             return FALSE;
3566
3567         /* it is actually just a matter of turning the utf8 flag on, but
3568          * we want to make sure everything inside is valid utf8 first.
3569          */
3570         c = (U8 *) SvPVX(sv);
3571         if (!is_utf8_string(c, SvCUR(sv)+1))
3572             return FALSE;
3573         e = (U8 *) SvEND(sv);
3574         while (c < e) {
3575             U8 ch = *c++;
3576             if (!UTF8_IS_INVARIANT(ch)) {
3577                 SvUTF8_on(sv);
3578                 break;
3579             }
3580         }
3581     }
3582     return TRUE;
3583 }
3584
3585 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3586  * this function provided for binary compatibility only
3587  */
3588
3589 void
3590 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3591 {
3592     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3593 }
3594
3595 /*
3596 =for apidoc sv_setsv
3597
3598 Copies the contents of the source SV C<ssv> into the destination SV
3599 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3600 function if the source SV needs to be reused. Does not handle 'set' magic.
3601 Loosely speaking, it performs a copy-by-value, obliterating any previous
3602 content of the destination.
3603
3604 You probably want to use one of the assortment of wrappers, such as
3605 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3606 C<SvSetMagicSV_nosteal>.
3607
3608 =for apidoc sv_setsv_flags
3609
3610 Copies the contents of the source SV C<ssv> into the destination SV
3611 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3612 function if the source SV needs to be reused. Does not handle 'set' magic.
3613 Loosely speaking, it performs a copy-by-value, obliterating any previous
3614 content of the destination.
3615 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3616 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3617 implemented in terms of this function.
3618
3619 You probably want to use one of the assortment of wrappers, such as
3620 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3621 C<SvSetMagicSV_nosteal>.
3622
3623 This is the primary function for copying scalars, and most other
3624 copy-ish functions and macros use this underneath.
3625
3626 =cut
3627 */
3628
3629 void
3630 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3631 {
3632     register U32 sflags;
3633     register int dtype;
3634     register int stype;
3635
3636     if (sstr == dstr)
3637         return;
3638     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3639     if (!sstr)
3640         sstr = &PL_sv_undef;
3641     stype = SvTYPE(sstr);
3642     dtype = SvTYPE(dstr);
3643
3644     SvAMAGIC_off(dstr);
3645     if ( SvVOK(dstr) )
3646     {
3647         /* need to nuke the magic */
3648         mg_free(dstr);
3649         SvRMAGICAL_off(dstr);
3650     }
3651
3652     /* There's a lot of redundancy below but we're going for speed here */
3653
3654     switch (stype) {
3655     case SVt_NULL:
3656       undef_sstr:
3657         if (dtype != SVt_PVGV) {
3658             (void)SvOK_off(dstr);
3659             return;
3660         }
3661         break;
3662     case SVt_IV:
3663         if (SvIOK(sstr)) {
3664             switch (dtype) {
3665             case SVt_NULL:
3666                 sv_upgrade(dstr, SVt_IV);
3667                 break;
3668             case SVt_NV:
3669                 sv_upgrade(dstr, SVt_PVNV);
3670                 break;
3671             case SVt_RV:
3672             case SVt_PV:
3673                 sv_upgrade(dstr, SVt_PVIV);
3674                 break;
3675             }
3676             (void)SvIOK_only(dstr);
3677             SvIVX(dstr) = SvIVX(sstr);
3678             if (SvIsUV(sstr))
3679                 SvIsUV_on(dstr);
3680             if (SvTAINTED(sstr))
3681                 SvTAINT(dstr);
3682             return;
3683         }
3684         goto undef_sstr;
3685
3686     case SVt_NV:
3687         if (SvNOK(sstr)) {
3688             switch (dtype) {
3689             case SVt_NULL:
3690             case SVt_IV:
3691                 sv_upgrade(dstr, SVt_NV);
3692                 break;
3693             case SVt_RV:
3694             case SVt_PV:
3695             case SVt_PVIV:
3696                 sv_upgrade(dstr, SVt_PVNV);
3697                 break;
3698             }
3699             SvNVX(dstr) = SvNVX(sstr);
3700             (void)SvNOK_only(dstr);
3701             if (SvTAINTED(sstr))
3702                 SvTAINT(dstr);
3703             return;
3704         }
3705         goto undef_sstr;
3706
3707     case SVt_RV:
3708         if (dtype < SVt_RV)
3709             sv_upgrade(dstr, SVt_RV);
3710         else if (dtype == SVt_PVGV &&
3711                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3712             sstr = SvRV(sstr);
3713             if (sstr == dstr) {
3714                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3715                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3716                 {
3717                     GvIMPORTED_on(dstr);
3718                 }
3719                 GvMULTI_on(dstr);
3720                 return;
3721             }
3722             goto glob_assign;
3723         }
3724         break;
3725     case SVt_PVFM:
3726 #ifdef PERL_COPY_ON_WRITE
3727         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3728             if (dtype < SVt_PVIV)
3729                 sv_upgrade(dstr, SVt_PVIV);
3730             break;
3731         }
3732         /* Fall through */
3733 #endif
3734     case SVt_PV:
3735         if (dtype < SVt_PV)
3736             sv_upgrade(dstr, SVt_PV);
3737         break;
3738     case SVt_PVIV:
3739         if (dtype < SVt_PVIV)
3740             sv_upgrade(dstr, SVt_PVIV);
3741         break;
3742     case SVt_PVNV:
3743         if (dtype < SVt_PVNV)
3744             sv_upgrade(dstr, SVt_PVNV);
3745         break;
3746     case SVt_PVAV:
3747     case SVt_PVHV:
3748     case SVt_PVCV:
3749     case SVt_PVIO:
3750         if (PL_op)
3751             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3752                 OP_NAME(PL_op));
3753         else
3754             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3755         break;
3756
3757     case SVt_PVGV:
3758         if (dtype <= SVt_PVGV) {
3759   glob_assign:
3760             if (dtype != SVt_PVGV) {
3761                 char *name = GvNAME(sstr);
3762                 STRLEN len = GvNAMELEN(sstr);
3763                 sv_upgrade(dstr, SVt_PVGV);
3764                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3765                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3766                 GvNAME(dstr) = savepvn(name, len);
3767                 GvNAMELEN(dstr) = len;
3768                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3769             }
3770             /* ahem, death to those who redefine active sort subs */
3771             else if (PL_curstackinfo->si_type == PERLSI_SORT
3772                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3773                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3774                       GvNAME(dstr));
3775
3776 #ifdef GV_UNIQUE_CHECK
3777                 if (GvUNIQUE((GV*)dstr)) {
3778                     Perl_croak(aTHX_ PL_no_modify);
3779                 }
3780 #endif
3781
3782             (void)SvOK_off(dstr);
3783             GvINTRO_off(dstr);          /* one-shot flag */
3784             gp_free((GV*)dstr);
3785             GvGP(dstr) = gp_ref(GvGP(sstr));
3786             if (SvTAINTED(sstr))
3787                 SvTAINT(dstr);
3788             if (GvIMPORTED(dstr) != GVf_IMPORTED
3789                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3790             {
3791                 GvIMPORTED_on(dstr);
3792             }
3793             GvMULTI_on(dstr);
3794             return;
3795         }
3796         /* FALL THROUGH */
3797
3798     default:
3799         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3800             mg_get(sstr);
3801             if ((int)SvTYPE(sstr) != stype) {
3802                 stype = SvTYPE(sstr);
3803                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3804                     goto glob_assign;
3805             }
3806         }
3807         if (stype == SVt_PVLV)
3808             (void)SvUPGRADE(dstr, SVt_PVNV);
3809         else
3810             (void)SvUPGRADE(dstr, (U32)stype);
3811     }
3812
3813     sflags = SvFLAGS(sstr);
3814
3815     if (sflags & SVf_ROK) {
3816         if (dtype >= SVt_PV) {
3817             if (dtype == SVt_PVGV) {
3818                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3819                 SV *dref = 0;
3820                 int intro = GvINTRO(dstr);
3821
3822 #ifdef GV_UNIQUE_CHECK
3823                 if (GvUNIQUE((GV*)dstr)) {
3824                     Perl_croak(aTHX_ PL_no_modify);
3825                 }
3826 #endif
3827
3828                 if (intro) {
3829                     GvINTRO_off(dstr);  /* one-shot flag */
3830                     GvLINE(dstr) = CopLINE(PL_curcop);
3831                     GvEGV(dstr) = (GV*)dstr;
3832                 }
3833                 GvMULTI_on(dstr);
3834                 switch (SvTYPE(sref)) {
3835                 case SVt_PVAV:
3836                     if (intro)
3837                         SAVEGENERICSV(GvAV(dstr));
3838                     else
3839                         dref = (SV*)GvAV(dstr);
3840                     GvAV(dstr) = (AV*)sref;
3841                     if (!GvIMPORTED_AV(dstr)
3842                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3843                     {
3844                         GvIMPORTED_AV_on(dstr);
3845                     }
3846                     break;
3847                 case SVt_PVHV:
3848                     if (intro)
3849                         SAVEGENERICSV(GvHV(dstr));
3850                     else
3851                         dref = (SV*)GvHV(dstr);
3852                     GvHV(dstr) = (HV*)sref;
3853                     if (!GvIMPORTED_HV(dstr)
3854                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3855                     {
3856                         GvIMPORTED_HV_on(dstr);
3857                     }
3858                     break;
3859                 case SVt_PVCV:
3860                     if (intro) {
3861                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3862                             SvREFCNT_dec(GvCV(dstr));
3863                             GvCV(dstr) = Nullcv;
3864                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3865                             PL_sub_generation++;
3866                         }
3867                         SAVEGENERICSV(GvCV(dstr));
3868                     }
3869                     else
3870                         dref = (SV*)GvCV(dstr);
3871                     if (GvCV(dstr) != (CV*)sref) {
3872                         CV* cv = GvCV(dstr);
3873                         if (cv) {
3874                             if (!GvCVGEN((GV*)dstr) &&
3875                                 (CvROOT(cv) || CvXSUB(cv)))
3876                             {
3877                                 /* ahem, death to those who redefine
3878                                  * active sort subs */
3879                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3880                                       PL_sortcop == CvSTART(cv))
3881                                     Perl_croak(aTHX_
3882                                     "Can't redefine active sort subroutine %s",
3883                                           GvENAME((GV*)dstr));
3884                                 /* Redefining a sub - warning is mandatory if
3885                                    it was a const and its value changed. */
3886                                 if (ckWARN(WARN_REDEFINE)
3887                                     || (CvCONST(cv)
3888                                         && (!CvCONST((CV*)sref)
3889                                             || sv_cmp(cv_const_sv(cv),
3890                                                       cv_const_sv((CV*)sref)))))
3891                                 {
3892                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3893                                         CvCONST(cv)
3894                                         ? "Constant subroutine %s::%s redefined"
3895                                         : "Subroutine %s::%s redefined",
3896                                         HvNAME(GvSTASH((GV*)dstr)),
3897                                         GvENAME((GV*)dstr));
3898                                 }
3899                             }
3900                             if (!intro)
3901                                 cv_ckproto(cv, (GV*)dstr,
3902                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
3903                         }
3904                         GvCV(dstr) = (CV*)sref;
3905                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3906                         GvASSUMECV_on(dstr);
3907                         PL_sub_generation++;
3908                     }
3909                     if (!GvIMPORTED_CV(dstr)
3910                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3911                     {
3912                         GvIMPORTED_CV_on(dstr);
3913                     }
3914                     break;
3915                 case SVt_PVIO:
3916                     if (intro)
3917                         SAVEGENERICSV(GvIOp(dstr));
3918                     else
3919                         dref = (SV*)GvIOp(dstr);
3920                     GvIOp(dstr) = (IO*)sref;
3921                     break;
3922                 case SVt_PVFM:
3923                     if (intro)
3924                         SAVEGENERICSV(GvFORM(dstr));
3925                     else
3926                         dref = (SV*)GvFORM(dstr);
3927                     GvFORM(dstr) = (CV*)sref;
3928                     break;
3929                 default:
3930                     if (intro)
3931                         SAVEGENERICSV(GvSV(dstr));
3932                     else
3933                         dref = (SV*)GvSV(dstr);
3934                     GvSV(dstr) = sref;
3935                     if (!GvIMPORTED_SV(dstr)
3936                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3937                     {
3938                         GvIMPORTED_SV_on(dstr);
3939                     }
3940                     break;
3941                 }
3942                 if (dref)
3943                     SvREFCNT_dec(dref);
3944                 if (SvTAINTED(sstr))
3945                     SvTAINT(dstr);
3946                 return;
3947             }
3948             if (SvPVX(dstr)) {
3949                 (void)SvOOK_off(dstr);          /* backoff */
3950                 if (SvLEN(dstr))
3951                     Safefree(SvPVX(dstr));
3952                 SvLEN(dstr)=SvCUR(dstr)=0;
3953             }
3954         }
3955         (void)SvOK_off(dstr);
3956         SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3957         SvROK_on(dstr);
3958         if (sflags & SVp_NOK) {
3959             SvNOKp_on(dstr);
3960             /* Only set the public OK flag if the source has public OK.  */
3961             if (sflags & SVf_NOK)
3962                 SvFLAGS(dstr) |= SVf_NOK;
3963             SvNVX(dstr) = SvNVX(sstr);
3964         }
3965         if (sflags & SVp_IOK) {
3966             (void)SvIOKp_on(dstr);
3967             if (sflags & SVf_IOK)
3968                 SvFLAGS(dstr) |= SVf_IOK;
3969             if (sflags & SVf_IVisUV)
3970                 SvIsUV_on(dstr);
3971             SvIVX(dstr) = SvIVX(sstr);
3972         }
3973         if (SvAMAGIC(sstr)) {
3974             SvAMAGIC_on(dstr);
3975         }
3976     }
3977     else if (sflags & SVp_POK) {
3978         bool isSwipe = 0;
3979
3980         /*
3981          * Check to see if we can just swipe the string.  If so, it's a
3982          * possible small lose on short strings, but a big win on long ones.
3983          * It might even be a win on short strings if SvPVX(dstr)
3984          * has to be allocated and SvPVX(sstr) has to be freed.
3985          */
3986
3987         /* Whichever path we take through the next code, we want this true,
3988            and doing it now facilitates the COW check.  */
3989         (void)SvPOK_only(dstr);
3990
3991         if (
3992 #ifdef PERL_COPY_ON_WRITE
3993             (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3994             &&
3995 #endif
3996             !(isSwipe =
3997                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3998                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3999                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4000                  SvLEN(sstr)    &&        /* and really is a string */
4001                                 /* and won't be needed again, potentially */
4002               !(PL_op && PL_op->op_type == OP_AASSIGN))
4003 #ifdef PERL_COPY_ON_WRITE
4004             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4005                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4006                  && SvTYPE(sstr) >= SVt_PVIV)
4007 #endif
4008             ) {
4009             /* Failed the swipe test, and it's not a shared hash key either.
4010                Have to copy the string.  */
4011             STRLEN len = SvCUR(sstr);
4012             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4013             Move(SvPVX(sstr),SvPVX(dstr),len,char);
4014             SvCUR_set(dstr, len);
4015             *SvEND(dstr) = '\0';
4016         } else {
4017             /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4018                be true in here.  */
4019 #ifdef PERL_COPY_ON_WRITE
4020             /* Either it's a shared hash key, or it's suitable for
4021                copy-on-write or we can swipe the string.  */
4022             if (DEBUG_C_TEST) {
4023                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4024                 sv_dump(sstr);
4025                 sv_dump(dstr);
4026             }
4027             if (!isSwipe) {
4028                 /* I believe I should acquire a global SV mutex if
4029                    it's a COW sv (not a shared hash key) to stop
4030                    it going un copy-on-write.
4031                    If the source SV has gone un copy on write between up there
4032                    and down here, then (assert() that) it is of the correct
4033                    form to make it copy on write again */
4034                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4035                     != (SVf_FAKE | SVf_READONLY)) {
4036                     SvREADONLY_on(sstr);
4037                     SvFAKE_on(sstr);
4038                     /* Make the source SV into a loop of 1.
4039                        (about to become 2) */
4040                     SV_COW_NEXT_SV_SET(sstr, sstr);
4041                 }
4042             }
4043 #endif
4044             /* Initial code is common.  */
4045             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
4046                 if (SvOOK(dstr)) {
4047                     SvFLAGS(dstr) &= ~SVf_OOK;
4048                     Safefree(SvPVX(dstr) - SvIVX(dstr));
4049                 }
4050                 else if (SvLEN(dstr))
4051                     Safefree(SvPVX(dstr));
4052             }
4053
4054 #ifdef PERL_COPY_ON_WRITE
4055             if (!isSwipe) {
4056                 /* making another shared SV.  */
4057                 STRLEN cur = SvCUR(sstr);
4058                 STRLEN len = SvLEN(sstr);
4059                 assert (SvTYPE(dstr) >= SVt_PVIV);
4060                 if (len) {
4061                     /* SvIsCOW_normal */
4062                     /* splice us in between source and next-after-source.  */
4063                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4064                     SV_COW_NEXT_SV_SET(sstr, dstr);
4065                     SvPV_set(dstr, SvPVX(sstr));
4066                 } else {
4067                     /* SvIsCOW_shared_hash */
4068                     UV hash = SvUVX(sstr);
4069                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4070                                           "Copy on write: Sharing hash\n"));
4071                     SvPV_set(dstr,
4072                              sharepvn(SvPVX(sstr),
4073                                       (sflags & SVf_UTF8?-cur:cur), hash));
4074                     SvUVX(dstr) = hash;
4075                 }
4076                 SvLEN(dstr) = len;
4077                 SvCUR(dstr) = cur;
4078                 SvREADONLY_on(dstr);
4079                 SvFAKE_on(dstr);
4080                 /* Relesase a global SV mutex.  */
4081             }
4082             else
4083 #endif
4084                 {       /* Passes the swipe test.  */
4085                 SvPV_set(dstr, SvPVX(sstr));
4086                 SvLEN_set(dstr, SvLEN(sstr));
4087                 SvCUR_set(dstr, SvCUR(sstr));
4088
4089                 SvTEMP_off(dstr);
4090                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4091                 SvPV_set(sstr, Nullch);
4092                 SvLEN_set(sstr, 0);
4093                 SvCUR_set(sstr, 0);
4094                 SvTEMP_off(sstr);
4095             }
4096         }
4097         if (sflags & SVf_UTF8)
4098             SvUTF8_on(dstr);
4099         /*SUPPRESS 560*/
4100         if (sflags & SVp_NOK) {
4101             SvNOKp_on(dstr);
4102             if (sflags & SVf_NOK)
4103                 SvFLAGS(dstr) |= SVf_NOK;
4104             SvNVX(dstr) = SvNVX(sstr);
4105         }
4106         if (sflags & SVp_IOK) {
4107             (void)SvIOKp_on(dstr);
4108             if (sflags & SVf_IOK)
4109                 SvFLAGS(dstr) |= SVf_IOK;
4110             if (sflags & SVf_IVisUV)
4111                 SvIsUV_on(dstr);
4112             SvIVX(dstr) = SvIVX(sstr);
4113         }
4114         if (SvVOK(sstr)) {
4115             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4116             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4117                         smg->mg_ptr, smg->mg_len);
4118             SvRMAGICAL_on(dstr);
4119         }
4120     }
4121     else if (sflags & SVp_IOK) {
4122         if (sflags & SVf_IOK)
4123             (void)SvIOK_only(dstr);
4124         else {
4125             (void)SvOK_off(dstr);
4126             (void)SvIOKp_on(dstr);
4127         }
4128         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4129         if (sflags & SVf_IVisUV)
4130             SvIsUV_on(dstr);
4131         SvIVX(dstr) = SvIVX(sstr);
4132         if (sflags & SVp_NOK) {
4133             if (sflags & SVf_NOK)
4134                 (void)SvNOK_on(dstr);
4135             else
4136                 (void)SvNOKp_on(dstr);
4137             SvNVX(dstr) = SvNVX(sstr);
4138         }
4139     }
4140     else if (sflags & SVp_NOK) {
4141         if (sflags & SVf_NOK)
4142             (void)SvNOK_only(dstr);
4143         else {
4144             (void)SvOK_off(dstr);
4145             SvNOKp_on(dstr);
4146         }
4147         SvNVX(dstr) = SvNVX(sstr);
4148     }
4149     else {
4150         if (dtype == SVt_PVGV) {
4151             if (ckWARN(WARN_MISC))
4152                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4153         }
4154         else
4155             (void)SvOK_off(dstr);
4156     }
4157     if (SvTAINTED(sstr))
4158         SvTAINT(dstr);
4159 }
4160
4161 /*
4162 =for apidoc sv_setsv_mg
4163
4164 Like C<sv_setsv>, but also handles 'set' magic.
4165
4166 =cut
4167 */
4168
4169 void
4170 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4171 {
4172     sv_setsv(dstr,sstr);
4173     SvSETMAGIC(dstr);
4174 }
4175
4176 #ifdef PERL_COPY_ON_WRITE
4177 SV *
4178 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4179 {
4180     STRLEN cur = SvCUR(sstr);
4181     STRLEN len = SvLEN(sstr);
4182     register char *new_pv;
4183
4184     if (DEBUG_C_TEST) {
4185         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4186                       sstr, dstr);
4187         sv_dump(sstr);
4188         if (dstr)
4189                     sv_dump(dstr);
4190     }
4191
4192     if (dstr) {
4193         if (SvTHINKFIRST(dstr))
4194             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4195         else if (SvPVX(dstr))
4196             Safefree(SvPVX(dstr));
4197     }
4198     else
4199         new_SV(dstr);
4200     SvUPGRADE (dstr, SVt_PVIV);
4201
4202     assert (SvPOK(sstr));
4203     assert (SvPOKp(sstr));
4204     assert (!SvIOK(sstr));
4205     assert (!SvIOKp(sstr));
4206     assert (!SvNOK(sstr));
4207     assert (!SvNOKp(sstr));
4208
4209     if (SvIsCOW(sstr)) {
4210
4211         if (SvLEN(sstr) == 0) {
4212             /* source is a COW shared hash key.  */
4213             UV hash = SvUVX(sstr);
4214             DEBUG_C(PerlIO_printf(Perl_debug_log,
4215                                   "Fast copy on write: Sharing hash\n"));
4216             SvUVX(dstr) = hash;
4217             new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4218             goto common_exit;
4219         }
4220         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4221     } else {
4222         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4223         SvUPGRADE (sstr, SVt_PVIV);
4224         SvREADONLY_on(sstr);
4225         SvFAKE_on(sstr);
4226         DEBUG_C(PerlIO_printf(Perl_debug_log,
4227                               "Fast copy on write: Converting sstr to COW\n"));
4228         SV_COW_NEXT_SV_SET(dstr, sstr);
4229     }
4230     SV_COW_NEXT_SV_SET(sstr, dstr);
4231     new_pv = SvPVX(sstr);
4232
4233   common_exit:
4234     SvPV_set(dstr, new_pv);
4235     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4236     if (SvUTF8(sstr))
4237         SvUTF8_on(dstr);
4238     SvLEN(dstr) = len;
4239     SvCUR(dstr) = cur;
4240     if (DEBUG_C_TEST) {
4241         sv_dump(dstr);
4242     }
4243     return dstr;
4244 }
4245 #endif
4246
4247 /*
4248 =for apidoc sv_setpvn
4249
4250 Copies a string into an SV.  The C<len> parameter indicates the number of
4251 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4252
4253 =cut
4254 */
4255
4256 void
4257 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4258 {
4259     register char *dptr;
4260
4261     SV_CHECK_THINKFIRST_COW_DROP(sv);
4262     if (!ptr) {
4263         (void)SvOK_off(sv);
4264         return;
4265     }
4266     else {
4267         /* len is STRLEN which is unsigned, need to copy to signed */
4268         IV iv = len;
4269         if (iv < 0)
4270             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4271     }
4272     (void)SvUPGRADE(sv, SVt_PV);
4273
4274     SvGROW(sv, len + 1);
4275     dptr = SvPVX(sv);
4276     Move(ptr,dptr,len,char);
4277     dptr[len] = '\0';
4278     SvCUR_set(sv, len);
4279     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4280     SvTAINT(sv);
4281 }
4282
4283 /*
4284 =for apidoc sv_setpvn_mg
4285
4286 Like C<sv_setpvn>, but also handles 'set' magic.
4287
4288 =cut
4289 */
4290
4291 void
4292 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4293 {
4294     sv_setpvn(sv,ptr,len);
4295     SvSETMAGIC(sv);
4296 }
4297
4298 /*
4299 =for apidoc sv_setpv
4300
4301 Copies a string into an SV.  The string must be null-terminated.  Does not
4302 handle 'set' magic.  See C<sv_setpv_mg>.
4303
4304 =cut
4305 */
4306
4307 void
4308 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4309 {
4310     register STRLEN len;
4311
4312     SV_CHECK_THINKFIRST_COW_DROP(sv);
4313     if (!ptr) {
4314         (void)SvOK_off(sv);
4315         return;
4316     }
4317     len = strlen(ptr);
4318     (void)SvUPGRADE(sv, SVt_PV);
4319
4320     SvGROW(sv, len + 1);
4321     Move(ptr,SvPVX(sv),len+1,char);
4322     SvCUR_set(sv, len);
4323     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4324     SvTAINT(sv);
4325 }
4326
4327 /*
4328 =for apidoc sv_setpv_mg
4329
4330 Like C<sv_setpv>, but also handles 'set' magic.
4331
4332 =cut
4333 */
4334
4335 void
4336 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4337 {
4338     sv_setpv(sv,ptr);
4339     SvSETMAGIC(sv);
4340 }
4341
4342 /*
4343 =for apidoc sv_usepvn
4344
4345 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4346 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4347 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4348 string length, C<len>, must be supplied.  This function will realloc the
4349 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4350 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4351 See C<sv_usepvn_mg>.
4352
4353 =cut
4354 */
4355
4356 void
4357 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4358 {
4359     SV_CHECK_THINKFIRST_COW_DROP(sv);
4360     (void)SvUPGRADE(sv, SVt_PV);
4361     if (!ptr) {
4362         (void)SvOK_off(sv);
4363         return;
4364     }
4365     (void)SvOOK_off(sv);
4366     if (SvPVX(sv) && SvLEN(sv))
4367         Safefree(SvPVX(sv));
4368     Renew(ptr, len+1, char);
4369     SvPVX(sv) = ptr;
4370     SvCUR_set(sv, len);
4371     SvLEN_set(sv, len+1);
4372     *SvEND(sv) = '\0';
4373     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4374     SvTAINT(sv);
4375 }
4376
4377 /*
4378 =for apidoc sv_usepvn_mg
4379
4380 Like C<sv_usepvn>, but also handles 'set' magic.
4381
4382 =cut
4383 */
4384
4385 void
4386 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4387 {
4388     sv_usepvn(sv,ptr,len);
4389     SvSETMAGIC(sv);
4390 }
4391
4392 #ifdef PERL_COPY_ON_WRITE
4393 /* Need to do this *after* making the SV normal, as we need the buffer
4394    pointer to remain valid until after we've copied it.  If we let go too early,
4395    another thread could invalidate it by unsharing last of the same hash key
4396    (which it can do by means other than releasing copy-on-write Svs)
4397    or by changing the other copy-on-write SVs in the loop.  */
4398 STATIC void
4399 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4400                  U32 hash, SV *after)
4401 {
4402     if (len) { /* this SV was SvIsCOW_normal(sv) */
4403          /* we need to find the SV pointing to us.  */
4404         SV *current = SV_COW_NEXT_SV(after);
4405
4406         if (current == sv) {
4407             /* The SV we point to points back to us (there were only two of us
4408                in the loop.)
4409                Hence other SV is no longer copy on write either.  */
4410             SvFAKE_off(after);
4411             SvREADONLY_off(after);
4412         } else {
4413             /* We need to follow the pointers around the loop.  */
4414             SV *next;
4415             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4416                 assert (next);
4417                 current = next;
4418                  /* don't loop forever if the structure is bust, and we have
4419                     a pointer into a closed loop.  */
4420                 assert (current != after);
4421                 assert (SvPVX(current) == pvx);
4422             }
4423             /* Make the SV before us point to the SV after us.  */
4424             SV_COW_NEXT_SV_SET(current, after);
4425         }
4426     } else {
4427         unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4428     }
4429 }
4430
4431 int
4432 Perl_sv_release_IVX(pTHX_ register SV *sv)
4433 {
4434     if (SvIsCOW(sv))
4435         sv_force_normal_flags(sv, 0);
4436     return SvOOK_off(sv);
4437 }
4438 #endif
4439 /*
4440 =for apidoc sv_force_normal_flags
4441
4442 Undo various types of fakery on an SV: if the PV is a shared string, make
4443 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4444 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4445 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4446 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4447 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4448 set to some other value.) In addition, the C<flags> parameter gets passed to
4449 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4450 with flags set to 0.
4451
4452 =cut
4453 */
4454
4455 void
4456 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4457 {
4458 #ifdef PERL_COPY_ON_WRITE
4459     if (SvREADONLY(sv)) {
4460         /* At this point I believe I should acquire a global SV mutex.  */
4461         if (SvFAKE(sv)) {
4462             char *pvx = SvPVX(sv);
4463             STRLEN len = SvLEN(sv);
4464             STRLEN cur = SvCUR(sv);
4465             U32 hash = SvUVX(sv);
4466             SV *next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
4467             if (DEBUG_C_TEST) {
4468                 PerlIO_printf(Perl_debug_log,
4469                               "Copy on write: Force normal %ld\n",
4470                               (long) flags);
4471                 sv_dump(sv);
4472             }
4473             SvFAKE_off(sv);
4474             SvREADONLY_off(sv);
4475             /* This SV doesn't own the buffer, so need to New() a new one:  */
4476             SvPVX(sv) = 0;
4477             SvLEN(sv) = 0;
4478             if (flags & SV_COW_DROP_PV) {
4479                 /* OK, so we don't need to copy our buffer.  */
4480                 SvPOK_off(sv);
4481             } else {
4482                 SvGROW(sv, cur + 1);
4483                 Move(pvx,SvPVX(sv),cur,char);
4484                 SvCUR(sv) = cur;
4485                 *SvEND(sv) = '\0';
4486             }
4487             sv_release_COW(sv, pvx, cur, len, hash, next);
4488             if (DEBUG_C_TEST) {
4489                 sv_dump(sv);
4490             }
4491         }
4492         else if (IN_PERL_RUNTIME)
4493             Perl_croak(aTHX_ PL_no_modify);
4494         /* At this point I believe that I can drop the global SV mutex.  */
4495     }
4496 #else
4497     if (SvREADONLY(sv)) {
4498         if (SvFAKE(sv)) {
4499             char *pvx = SvPVX(sv);
4500             int is_utf8 = SvUTF8(sv);
4501             STRLEN len = SvCUR(sv);
4502             U32 hash   = SvUVX(sv);
4503             SvFAKE_off(sv);
4504             SvREADONLY_off(sv);
4505             SvPVX(sv) = 0;
4506             SvLEN(sv) = 0;
4507             SvGROW(sv, len + 1);
4508             Move(pvx,SvPVX(sv),len,char);
4509             *SvEND(sv) = '\0';
4510             unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4511         }
4512         else if (IN_PERL_RUNTIME)
4513             Perl_croak(aTHX_ PL_no_modify);
4514     }
4515 #endif
4516     if (SvROK(sv))
4517         sv_unref_flags(sv, flags);
4518     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4519         sv_unglob(sv);
4520 }
4521
4522 /*
4523 =for apidoc sv_force_normal
4524
4525 Undo various types of fakery on an SV: if the PV is a shared string, make
4526 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4527 an xpvmg. See also C<sv_force_normal_flags>.
4528
4529 =cut
4530 */
4531
4532 void
4533 Perl_sv_force_normal(pTHX_ register SV *sv)
4534 {
4535     sv_force_normal_flags(sv, 0);
4536 }
4537
4538 /*
4539 =for apidoc sv_chop
4540
4541 Efficient removal of characters from the beginning of the string buffer.
4542 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4543 the string buffer.  The C<ptr> becomes the first character of the adjusted
4544 string. Uses the "OOK hack".
4545 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4546 refer to the same chunk of data.
4547
4548 =cut
4549 */
4550
4551 void
4552 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4553 {
4554     register STRLEN delta;
4555     if (!ptr || !SvPOKp(sv))
4556         return;
4557     delta = ptr - SvPVX(sv);
4558     SV_CHECK_THINKFIRST(sv);
4559     if (SvTYPE(sv) < SVt_PVIV)
4560         sv_upgrade(sv,SVt_PVIV);
4561
4562     if (!SvOOK(sv)) {
4563         if (!SvLEN(sv)) { /* make copy of shared string */
4564             char *pvx = SvPVX(sv);
4565             STRLEN len = SvCUR(sv);
4566             SvGROW(sv, len + 1);
4567             Move(pvx,SvPVX(sv),len,char);
4568             *SvEND(sv) = '\0';
4569         }
4570         SvIVX(sv) = 0;
4571         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4572            and we do that anyway inside the SvNIOK_off
4573         */
4574         SvFLAGS(sv) |= SVf_OOK;
4575     }
4576     SvNIOK_off(sv);
4577     SvLEN(sv) -= delta;
4578     SvCUR(sv) -= delta;
4579     SvPVX(sv) += delta;
4580     SvIVX(sv) += delta;
4581 }
4582
4583 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4584  * this function provided for binary compatibility only
4585  */
4586
4587 void
4588 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4589 {
4590     sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4591 }
4592
4593 /*
4594 =for apidoc sv_catpvn
4595
4596 Concatenates the string onto the end of the string which is in the SV.  The
4597 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4598 status set, then the bytes appended should be valid UTF-8.
4599 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4600
4601 =for apidoc sv_catpvn_flags
4602
4603 Concatenates the string onto the end of the string which is in the SV.  The
4604 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4605 status set, then the bytes appended should be valid UTF-8.
4606 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4607 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4608 in terms of this function.
4609
4610 =cut
4611 */
4612
4613 void
4614 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4615 {
4616     STRLEN dlen;
4617     char *dstr;
4618
4619     dstr = SvPV_force_flags(dsv, dlen, flags);
4620     SvGROW(dsv, dlen + slen + 1);
4621     if (sstr == dstr)
4622         sstr = SvPVX(dsv);
4623     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4624     SvCUR(dsv) += slen;
4625     *SvEND(dsv) = '\0';
4626     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4627     SvTAINT(dsv);
4628 }
4629
4630 /*
4631 =for apidoc sv_catpvn_mg
4632
4633 Like C<sv_catpvn>, but also handles 'set' magic.
4634
4635 =cut
4636 */
4637
4638 void
4639 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4640 {
4641     sv_catpvn(sv,ptr,len);
4642     SvSETMAGIC(sv);
4643 }
4644
4645 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4646  * this function provided for binary compatibility only
4647  */
4648
4649 void
4650 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4651 {
4652     sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4653 }
4654
4655 /*
4656 =for apidoc sv_catsv
4657
4658 Concatenates the string from SV C<ssv> onto the end of the string in
4659 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4660 not 'set' magic.  See C<sv_catsv_mg>.
4661
4662 =for apidoc sv_catsv_flags
4663
4664 Concatenates the string from SV C<ssv> onto the end of the string in
4665 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4666 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4667 and C<sv_catsv_nomg> are implemented in terms of this function.
4668
4669 =cut */
4670
4671 void
4672 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4673 {
4674     char *spv;
4675     STRLEN slen;
4676     if (!ssv)
4677         return;
4678     if ((spv = SvPV(ssv, slen))) {
4679         /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4680             gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4681             Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4682             get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4683             dsv->sv_flags doesn't have that bit set.
4684                 Andy Dougherty  12 Oct 2001
4685         */
4686         I32 sutf8 = DO_UTF8(ssv);
4687         I32 dutf8;
4688
4689         if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4690             mg_get(dsv);
4691         dutf8 = DO_UTF8(dsv);
4692
4693         if (dutf8 != sutf8) {
4694             if (dutf8) {
4695                 /* Not modifying source SV, so taking a temporary copy. */
4696                 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4697
4698                 sv_utf8_upgrade(csv);
4699                 spv = SvPV(csv, slen);
4700             }
4701             else
4702                 sv_utf8_upgrade_nomg(dsv);
4703         }
4704         sv_catpvn_nomg(dsv, spv, slen);
4705     }
4706 }
4707
4708 /*
4709 =for apidoc sv_catsv_mg
4710
4711 Like C<sv_catsv>, but also handles 'set' magic.
4712
4713 =cut
4714 */
4715
4716 void
4717 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4718 {
4719     sv_catsv(dsv,ssv);
4720     SvSETMAGIC(dsv);
4721 }
4722
4723 /*
4724 =for apidoc sv_catpv
4725
4726 Concatenates the string onto the end of the string which is in the SV.
4727 If the SV has the UTF-8 status set, then the bytes appended should be
4728 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4729
4730 =cut */
4731
4732 void
4733 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4734 {
4735     register STRLEN len;
4736     STRLEN tlen;
4737     char *junk;
4738
4739     if (!ptr)
4740         return;
4741     junk = SvPV_force(sv, tlen);
4742     len = strlen(ptr);
4743     SvGROW(sv, tlen + len + 1);
4744     if (ptr == junk)
4745         ptr = SvPVX(sv);
4746     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4747     SvCUR(sv) += len;
4748     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4749     SvTAINT(sv);
4750 }
4751
4752 /*
4753 =for apidoc sv_catpv_mg
4754
4755 Like C<sv_catpv>, but also handles 'set' magic.
4756
4757 =cut
4758 */
4759
4760 void
4761 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4762 {
4763     sv_catpv(sv,ptr);
4764     SvSETMAGIC(sv);
4765 }
4766
4767 /*
4768 =for apidoc newSV
4769
4770 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4771 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4772 macro.
4773
4774 =cut
4775 */
4776
4777 SV *
4778 Perl_newSV(pTHX_ STRLEN len)
4779 {
4780     register SV *sv;
4781
4782     new_SV(sv);
4783     if (len) {
4784         sv_upgrade(sv, SVt_PV);
4785         SvGROW(sv, len + 1);
4786     }
4787     return sv;
4788 }
4789 /*
4790 =for apidoc sv_magicext
4791
4792 Adds magic to an SV, upgrading it if necessary. Applies the
4793 supplied vtable and returns pointer to the magic added.
4794
4795 Note that sv_magicext will allow things that sv_magic will not.
4796 In particular you can add magic to SvREADONLY SVs and and more than
4797 one instance of the same 'how'
4798
4799 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4800 if C<namelen> is zero then C<name> is stored as-is and - as another special
4801 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4802 an C<SV*> and has its REFCNT incremented
4803
4804 (This is now used as a subroutine by sv_magic.)
4805
4806 =cut
4807 */
4808 MAGIC *
4809 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4810                  const char* name, I32 namlen)
4811 {
4812     MAGIC* mg;
4813
4814     if (SvTYPE(sv) < SVt_PVMG) {
4815         (void)SvUPGRADE(sv, SVt_PVMG);
4816     }
4817     Newz(702,mg, 1, MAGIC);
4818     mg->mg_moremagic = SvMAGIC(sv);
4819     SvMAGIC(sv) = mg;
4820
4821     /* Some magic sontains a reference loop, where the sv and object refer to
4822        each other.  To prevent a reference loop that would prevent such
4823        objects being freed, we look for such loops and if we find one we
4824        avoid incrementing the object refcount.
4825
4826        Note we cannot do this to avoid self-tie loops as intervening RV must
4827        have its REFCNT incremented to keep it in existence.
4828
4829     */
4830     if (!obj || obj == sv ||
4831         how == PERL_MAGIC_arylen ||
4832         how == PERL_MAGIC_qr ||
4833         (SvTYPE(obj) == SVt_PVGV &&
4834             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4835             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4836             GvFORM(obj) == (CV*)sv)))
4837     {
4838         mg->mg_obj = obj;
4839     }
4840     else {
4841         mg->mg_obj = SvREFCNT_inc(obj);
4842         mg->mg_flags |= MGf_REFCOUNTED;
4843     }
4844
4845     /* Normal self-ties simply pass a null object, and instead of
4846        using mg_obj directly, use the SvTIED_obj macro to produce a
4847        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4848        with an RV obj pointing to the glob containing the PVIO.  In
4849        this case, to avoid a reference loop, we need to weaken the
4850        reference.
4851     */
4852
4853     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4854         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4855     {
4856       sv_rvweaken(obj);
4857     }
4858
4859     mg->mg_type = how;
4860     mg->mg_len = namlen;
4861     if (name) {
4862         if (namlen > 0)
4863             mg->mg_ptr = savepvn(name, namlen);
4864         else if (namlen == HEf_SVKEY)
4865             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4866         else
4867             mg->mg_ptr = (char *) name;
4868     }
4869     mg->mg_virtual = vtable;
4870
4871     mg_magical(sv);
4872     if (SvGMAGICAL(sv))
4873         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4874     return mg;
4875 }
4876
4877 /*
4878 =for apidoc sv_magic
4879
4880 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4881 then adds a new magic item of type C<how> to the head of the magic list.
4882
4883 =cut
4884 */
4885
4886 void
4887 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4888 {
4889     MAGIC* mg;
4890     MGVTBL *vtable = 0;
4891
4892 #ifdef PERL_COPY_ON_WRITE
4893     if (SvIsCOW(sv))
4894         sv_force_normal_flags(sv, 0);
4895 #endif
4896     if (SvREADONLY(sv)) {
4897         if (IN_PERL_RUNTIME
4898             && how != PERL_MAGIC_regex_global
4899             && how != PERL_MAGIC_bm
4900             && how != PERL_MAGIC_fm
4901             && how != PERL_MAGIC_sv
4902            )
4903         {
4904             Perl_croak(aTHX_ PL_no_modify);
4905         }
4906     }
4907     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4908         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4909             /* sv_magic() refuses to add a magic of the same 'how' as an
4910                existing one
4911              */
4912             if (how == PERL_MAGIC_taint)
4913                 mg->mg_len |= 1;
4914             return;
4915         }
4916     }
4917
4918     switch (how) {
4919     case PERL_MAGIC_sv:
4920         vtable = &PL_vtbl_sv;
4921         break;
4922     case PERL_MAGIC_overload:
4923         vtable = &PL_vtbl_amagic;
4924         break;
4925     case PERL_MAGIC_overload_elem:
4926         vtable = &PL_vtbl_amagicelem;
4927         break;
4928     case PERL_MAGIC_overload_table:
4929         vtable = &PL_vtbl_ovrld;
4930         break;
4931     case PERL_MAGIC_bm:
4932         vtable = &PL_vtbl_bm;
4933         break;
4934     case PERL_MAGIC_regdata:
4935         vtable = &PL_vtbl_regdata;
4936         break;
4937     case PERL_MAGIC_regdatum:
4938         vtable = &PL_vtbl_regdatum;
4939         break;
4940     case PERL_MAGIC_env:
4941         vtable = &PL_vtbl_env;
4942         break;
4943     case PERL_MAGIC_fm:
4944         vtable = &PL_vtbl_fm;
4945         break;
4946     case PERL_MAGIC_envelem:
4947         vtable = &PL_vtbl_envelem;
4948         break;
4949     case PERL_MAGIC_regex_global:
4950         vtable = &PL_vtbl_mglob;
4951         break;
4952     case PERL_MAGIC_isa:
4953         vtable = &PL_vtbl_isa;
4954         break;
4955     case PERL_MAGIC_isaelem:
4956         vtable = &PL_vtbl_isaelem;
4957         break;
4958     case PERL_MAGIC_nkeys:
4959         vtable = &PL_vtbl_nkeys;
4960         break;
4961     case PERL_MAGIC_dbfile:
4962         vtable = 0;
4963         break;
4964     case PERL_MAGIC_dbline:
4965         vtable = &PL_vtbl_dbline;
4966         break;
4967 #ifdef USE_LOCALE_COLLATE
4968     case PERL_MAGIC_collxfrm:
4969         vtable = &PL_vtbl_collxfrm;
4970         break;
4971 #endif /* USE_LOCALE_COLLATE */
4972     case PERL_MAGIC_tied:
4973         vtable = &PL_vtbl_pack;
4974         break;
4975     case PERL_MAGIC_tiedelem:
4976     case PERL_MAGIC_tiedscalar:
4977         vtable = &PL_vtbl_packelem;
4978         break;
4979     case PERL_MAGIC_qr:
4980         vtable = &PL_vtbl_regexp;
4981         break;
4982     case PERL_MAGIC_sig:
4983         vtable = &PL_vtbl_sig;
4984         break;
4985     case PERL_MAGIC_sigelem:
4986         vtable = &PL_vtbl_sigelem;
4987         break;
4988     case PERL_MAGIC_taint:
4989         vtable = &PL_vtbl_taint;
4990         break;
4991     case PERL_MAGIC_uvar:
4992         vtable = &PL_vtbl_uvar;
4993         break;
4994     case PERL_MAGIC_vec:
4995         vtable = &PL_vtbl_vec;
4996         break;
4997     case PERL_MAGIC_vstring:
4998         vtable = 0;
4999         break;
5000     case PERL_MAGIC_utf8:
5001         vtable = &PL_vtbl_utf8;
5002         break;
5003     case PERL_MAGIC_substr:
5004         vtable = &PL_vtbl_substr;
5005         break;
5006     case PERL_MAGIC_defelem:
5007         vtable = &PL_vtbl_defelem;
5008         break;
5009     case PERL_MAGIC_glob:
5010         vtable = &PL_vtbl_glob;
5011         break;
5012     case PERL_MAGIC_arylen:
5013         vtable = &PL_vtbl_arylen;
5014         break;
5015     case PERL_MAGIC_pos:
5016         vtable = &PL_vtbl_pos;
5017         break;
5018     case PERL_MAGIC_backref:
5019         vtable = &PL_vtbl_backref;
5020         break;
5021     case PERL_MAGIC_ext:
5022         /* Reserved for use by extensions not perl internals.           */
5023         /* Useful for attaching extension internal data to perl vars.   */
5024         /* Note that multiple extensions may clash if magical scalars   */
5025         /* etc holding private data from one are passed to another.     */
5026         break;
5027     default:
5028         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5029     }
5030
5031     /* Rest of work is done else where */
5032     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5033
5034     switch (how) {
5035     case PERL_MAGIC_taint:
5036         mg->mg_len = 1;
5037         break;
5038     case PERL_MAGIC_ext:
5039     case PERL_MAGIC_dbfile:
5040         SvRMAGICAL_on(sv);
5041         break;
5042     }
5043 }
5044
5045 /*
5046 =for apidoc sv_unmagic
5047
5048 Removes all magic of type C<type> from an SV.
5049
5050 =cut
5051 */
5052
5053 int
5054 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5055 {
5056     MAGIC* mg;
5057     MAGIC** mgp;
5058     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5059         return 0;
5060     mgp = &SvMAGIC(sv);
5061     for (mg = *mgp; mg; mg = *mgp) {
5062         if (mg->mg_type == type) {
5063             MGVTBL* vtbl = mg->mg_virtual;
5064             *mgp = mg->mg_moremagic;
5065             if (vtbl && vtbl->svt_free)
5066                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5067             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5068                 if (mg->mg_len > 0)
5069                     Safefree(mg->mg_ptr);
5070                 else if (mg->mg_len == HEf_SVKEY)
5071                     SvREFCNT_dec((SV*)mg->mg_ptr);
5072                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5073                     Safefree(mg->mg_ptr);
5074             }
5075             if (mg->mg_flags & MGf_REFCOUNTED)
5076                 SvREFCNT_dec(mg->mg_obj);
5077             Safefree(mg);
5078         }
5079         else
5080             mgp = &mg->mg_moremagic;
5081     }
5082     if (!SvMAGIC(sv)) {
5083         SvMAGICAL_off(sv);
5084        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5085     }
5086
5087     return 0;
5088 }
5089
5090 /*
5091 =for apidoc sv_rvweaken
5092
5093 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5094 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5095 push a back-reference to this RV onto the array of backreferences
5096 associated with that magic.
5097
5098 =cut
5099 */
5100
5101 SV *
5102 Perl_sv_rvweaken(pTHX_ SV *sv)
5103 {
5104     SV *tsv;
5105     if (!SvOK(sv))  /* let undefs pass */
5106         return sv;
5107     if (!SvROK(sv))
5108         Perl_croak(aTHX_ "Can't weaken a nonreference");
5109     else if (SvWEAKREF(sv)) {
5110         if (ckWARN(WARN_MISC))
5111             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5112         return sv;
5113     }
5114     tsv = SvRV(sv);
5115     sv_add_backref(tsv, sv);
5116     SvWEAKREF_on(sv);
5117     SvREFCNT_dec(tsv);
5118     return sv;
5119 }
5120
5121 /* Give tsv backref magic if it hasn't already got it, then push a
5122  * back-reference to sv onto the array associated with the backref magic.
5123  */
5124
5125 STATIC void
5126 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5127 {
5128     AV *av;
5129     MAGIC *mg;
5130     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5131         av = (AV*)mg->mg_obj;
5132     else {
5133         av = newAV();
5134         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5135         /* av now has a refcnt of 2, which avoids it getting freed
5136          * before us during global cleanup. The extra ref is removed
5137          * by magic_killbackrefs() when tsv is being freed */
5138     }
5139     if (AvFILLp(av) >= AvMAX(av)) {
5140         SV **svp = AvARRAY(av);
5141         I32 i = AvFILLp(av);
5142         while (i >= 0) {
5143             if (svp[i] == &PL_sv_undef) {
5144                 svp[i] = sv;        /* reuse the slot */
5145                 return;
5146             }
5147             i--;
5148         }
5149         av_extend(av, AvFILLp(av)+1);
5150     }
5151     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5152 }
5153
5154 /* delete a back-reference to ourselves from the backref magic associated
5155  * with the SV we point to.
5156  */
5157
5158 STATIC void
5159 S_sv_del_backref(pTHX_ SV *sv)
5160 {
5161     AV *av;
5162     SV **svp;
5163     I32 i;
5164     SV *tsv = SvRV(sv);
5165     MAGIC *mg = NULL;
5166     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5167         Perl_croak(aTHX_ "panic: del_backref");
5168     av = (AV *)mg->mg_obj;
5169     svp = AvARRAY(av);
5170     i = AvFILLp(av);
5171     while (i >= 0) {
5172         if (svp[i] == sv) {
5173             svp[i] = &PL_sv_undef; /* XXX */
5174         }
5175         i--;
5176     }
5177 }
5178
5179 /*
5180 =for apidoc sv_insert
5181
5182 Inserts a string at the specified offset/length within the SV. Similar to
5183 the Perl substr() function.
5184
5185 =cut
5186 */
5187
5188 void
5189 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5190 {
5191     register char *big;
5192     register char *mid;
5193     register char *midend;
5194     register char *bigend;
5195     register I32 i;
5196     STRLEN curlen;
5197
5198
5199     if (!bigstr)
5200         Perl_croak(aTHX_ "Can't modify non-existent substring");
5201     SvPV_force(bigstr, curlen);
5202     (void)SvPOK_only_UTF8(bigstr);
5203     if (offset + len > curlen) {
5204         SvGROW(bigstr, offset+len+1);
5205         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5206         SvCUR_set(bigstr, offset+len);
5207     }
5208
5209     SvTAINT(bigstr);
5210     i = littlelen - len;
5211     if (i > 0) {                        /* string might grow */
5212         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5213         mid = big + offset + len;
5214         midend = bigend = big + SvCUR(bigstr);
5215         bigend += i;
5216         *bigend = '\0';
5217         while (midend > mid)            /* shove everything down */
5218             *--bigend = *--midend;
5219         Move(little,big+offset,littlelen,char);
5220         SvCUR(bigstr) += i;
5221         SvSETMAGIC(bigstr);
5222         return;
5223     }
5224     else if (i == 0) {
5225         Move(little,SvPVX(bigstr)+offset,len,char);
5226         SvSETMAGIC(bigstr);
5227         return;
5228     }
5229
5230     big = SvPVX(bigstr);
5231     mid = big + offset;
5232     midend = mid + len;
5233     bigend = big + SvCUR(bigstr);
5234
5235     if (midend > bigend)
5236         Perl_croak(aTHX_ "panic: sv_insert");
5237
5238     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5239         if (littlelen) {
5240             Move(little, mid, littlelen,char);
5241             mid += littlelen;
5242         }
5243         i = bigend - midend;
5244         if (i > 0) {
5245             Move(midend, mid, i,char);
5246             mid += i;
5247         }
5248         *mid = '\0';
5249         SvCUR_set(bigstr, mid - big);
5250     }
5251     /*SUPPRESS 560*/
5252     else if ((i = mid - big)) { /* faster from front */
5253         midend -= littlelen;
5254         mid = midend;
5255         sv_chop(bigstr,midend-i);
5256         big += i;
5257         while (i--)
5258             *--midend = *--big;
5259         if (littlelen)
5260             Move(little, mid, littlelen,char);
5261     }
5262     else if (littlelen) {
5263         midend -= littlelen;
5264         sv_chop(bigstr,midend);
5265         Move(little,midend,littlelen,char);
5266     }
5267     else {
5268         sv_chop(bigstr,midend);
5269     }
5270     SvSETMAGIC(bigstr);
5271 }
5272
5273 /*
5274 =for apidoc sv_replace
5275
5276 Make the first argument a copy of the second, then delete the original.
5277 The target SV physically takes over ownership of the body of the source SV
5278 and inherits its flags; however, the target keeps any magic it owns,
5279 and any magic in the source is discarded.
5280 Note that this is a rather specialist SV copying operation; most of the
5281 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5282
5283 =cut
5284 */
5285
5286 void
5287 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5288 {
5289     U32 refcnt = SvREFCNT(sv);
5290     SV_CHECK_THINKFIRST_COW_DROP(sv);
5291     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5292         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5293     if (SvMAGICAL(sv)) {
5294         if (SvMAGICAL(nsv))
5295             mg_free(nsv);
5296         else
5297             sv_upgrade(nsv, SVt_PVMG);
5298         SvMAGIC(nsv) = SvMAGIC(sv);
5299         SvFLAGS(nsv) |= SvMAGICAL(sv);
5300         SvMAGICAL_off(sv);
5301         SvMAGIC(sv) = 0;
5302     }
5303     SvREFCNT(sv) = 0;
5304     sv_clear(sv);
5305     assert(!SvREFCNT(sv));
5306     StructCopy(nsv,sv,SV);
5307 #ifdef PERL_COPY_ON_WRITE
5308     if (SvIsCOW_normal(nsv)) {
5309         /* We need to follow the pointers around the loop to make the
5310            previous SV point to sv, rather than nsv.  */
5311         SV *next;
5312         SV *current = nsv;
5313         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5314             assert(next);
5315             current = next;
5316             assert(SvPVX(current) == SvPVX(nsv));
5317         }
5318         /* Make the SV before us point to the SV after us.  */
5319         if (DEBUG_C_TEST) {
5320             PerlIO_printf(Perl_debug_log, "previous is\n");
5321             sv_dump(current);
5322             PerlIO_printf(Perl_debug_log,
5323                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5324                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5325         }
5326         SV_COW_NEXT_SV_SET(current, sv);
5327     }
5328 #endif
5329     SvREFCNT(sv) = refcnt;
5330     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5331     SvREFCNT(nsv) = 0;
5332     del_SV(nsv);
5333 }
5334
5335 /*
5336 =for apidoc sv_clear
5337
5338 Clear an SV: call any destructors, free up any memory used by the body,
5339 and free the body itself. The SV's head is I<not> freed, although
5340 its type is set to all 1's so that it won't inadvertently be assumed
5341 to be live during global destruction etc.
5342 This function should only be called when REFCNT is zero. Most of the time
5343 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5344 instead.
5345
5346 =cut
5347 */
5348
5349 void
5350 Perl_sv_clear(pTHX_ register SV *sv)
5351 {
5352     HV* stash;
5353     assert(sv);
5354     assert(SvREFCNT(sv) == 0);
5355
5356     if (SvOBJECT(sv)) {
5357         if (PL_defstash) {              /* Still have a symbol table? */
5358             dSP;
5359             CV* destructor;
5360
5361
5362
5363             do {
5364                 stash = SvSTASH(sv);
5365                 destructor = StashHANDLER(stash,DESTROY);
5366                 if (destructor) {
5367                     SV* tmpref = newRV(sv);
5368                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
5369                     ENTER;
5370                     PUSHSTACKi(PERLSI_DESTROY);
5371                     EXTEND(SP, 2);
5372                     PUSHMARK(SP);
5373                     PUSHs(tmpref);
5374                     PUTBACK;
5375                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5376
5377
5378                     POPSTACK;
5379                     SPAGAIN;
5380                     LEAVE;
5381                     if(SvREFCNT(tmpref) < 2) {
5382                         /* tmpref is not kept alive! */
5383                         SvREFCNT(sv)--;
5384                         SvRV(tmpref) = 0;
5385                         SvROK_off(tmpref);
5386                     }
5387                     SvREFCNT_dec(tmpref);
5388                 }
5389             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5390
5391
5392             if (SvREFCNT(sv)) {
5393                 if (PL_in_clean_objs)
5394                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5395                           HvNAME(stash));
5396                 /* DESTROY gave object new lease on life */
5397                 return;
5398             }
5399         }
5400
5401         if (SvOBJECT(sv)) {
5402             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
5403             SvOBJECT_off(sv);   /* Curse the object. */
5404             if (SvTYPE(sv) != SVt_PVIO)
5405                 --PL_sv_objcount;       /* XXX Might want something more general */
5406         }
5407     }
5408     if (SvTYPE(sv) >= SVt_PVMG) {
5409         if (SvMAGIC(sv))
5410             mg_free(sv);
5411         if (SvFLAGS(sv) & SVpad_TYPED)
5412             SvREFCNT_dec(SvSTASH(sv));
5413     }
5414     stash = NULL;
5415     switch (SvTYPE(sv)) {
5416     case SVt_PVIO:
5417         if (IoIFP(sv) &&
5418             IoIFP(sv) != PerlIO_stdin() &&
5419             IoIFP(sv) != PerlIO_stdout() &&
5420             IoIFP(sv) != PerlIO_stderr())
5421         {
5422             io_close((IO*)sv, FALSE);
5423         }
5424         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5425             PerlDir_close(IoDIRP(sv));
5426         IoDIRP(sv) = (DIR*)NULL;
5427         Safefree(IoTOP_NAME(sv));
5428         Safefree(IoFMT_NAME(sv));
5429         Safefree(IoBOTTOM_NAME(sv));
5430         /* FALL THROUGH */
5431     case SVt_PVBM:
5432         goto freescalar;
5433     case SVt_PVCV:
5434     case SVt_PVFM:
5435         cv_undef((CV*)sv);
5436         goto freescalar;
5437     case SVt_PVHV:
5438         hv_undef((HV*)sv);
5439         break;
5440     case SVt_PVAV:
5441         av_undef((AV*)sv);
5442         break;
5443     case SVt_PVLV:
5444         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5445             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5446             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5447             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5448         }
5449         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
5450             SvREFCNT_dec(LvTARG(sv));
5451         goto freescalar;
5452     case SVt_PVGV:
5453         gp_free((GV*)sv);
5454         Safefree(GvNAME(sv));
5455         /* cannot decrease stash refcount yet, as we might recursively delete
5456            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5457            of stash until current sv is completely gone.
5458            -- JohnPC, 27 Mar 1998 */
5459         stash = GvSTASH(sv);
5460         /* FALL THROUGH */
5461     case SVt_PVMG:
5462     case SVt_PVNV:
5463     case SVt_PVIV:
5464       freescalar:
5465         (void)SvOOK_off(sv);
5466         /* FALL THROUGH */
5467     case SVt_PV:
5468     case SVt_RV:
5469         if (SvROK(sv)) {
5470             if (SvWEAKREF(sv))
5471                 sv_del_backref(sv);
5472             else
5473                 SvREFCNT_dec(SvRV(sv));
5474         }
5475 #ifdef PERL_COPY_ON_WRITE
5476         else if (SvPVX(sv)) {
5477             if (SvIsCOW(sv)) {
5478                 /* I believe I need to grab the global SV mutex here and
5479                    then recheck the COW status.  */
5480                 if (DEBUG_C_TEST) {
5481                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5482                     sv_dump(sv);
5483                 }
5484                 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5485                                  SvUVX(sv), SV_COW_NEXT_SV(sv));
5486                 /* And drop it here.  */
5487                 SvFAKE_off(sv);
5488             } else if (SvLEN(sv)) {
5489                 Safefree(SvPVX(sv));
5490             }
5491         }
5492 #else
5493         else if (SvPVX(sv) && SvLEN(sv))
5494             Safefree(SvPVX(sv));
5495         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5496             unsharepvn(SvPVX(sv),
5497                        SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5498                        SvUVX(sv));
5499             SvFAKE_off(sv);
5500         }
5501 #endif
5502         break;
5503 /*
5504     case SVt_NV:
5505     case SVt_IV:
5506     case SVt_NULL:
5507         break;
5508 */
5509     }
5510
5511     switch (SvTYPE(sv)) {
5512     case SVt_NULL:
5513         break;
5514     case SVt_IV:
5515         del_XIV(SvANY(sv));
5516         break;
5517     case SVt_NV:
5518         del_XNV(SvANY(sv));
5519         break;
5520     case SVt_RV:
5521         del_XRV(SvANY(sv));
5522         break;
5523     case SVt_PV:
5524         del_XPV(SvANY(sv));
5525         break;
5526     case SVt_PVIV:
5527         del_XPVIV(SvANY(sv));
5528         break;
5529     case SVt_PVNV:
5530         del_XPVNV(SvANY(sv));
5531         break;
5532     case SVt_PVMG:
5533         del_XPVMG(SvANY(sv));
5534         break;
5535     case SVt_PVLV:
5536         del_XPVLV(SvANY(sv));
5537         break;
5538     case SVt_PVAV:
5539         del_XPVAV(SvANY(sv));
5540         break;
5541     case SVt_PVHV:
5542         del_XPVHV(SvANY(sv));
5543         break;
5544     case SVt_PVCV:
5545         del_XPVCV(SvANY(sv));
5546         break;
5547     case SVt_PVGV:
5548         del_XPVGV(SvANY(sv));
5549         /* code duplication for increased performance. */
5550         SvFLAGS(sv) &= SVf_BREAK;
5551         SvFLAGS(sv) |= SVTYPEMASK;
5552         /* decrease refcount of the stash that owns this GV, if any */
5553         if (stash)
5554             SvREFCNT_dec(stash);
5555         return; /* not break, SvFLAGS reset already happened */
5556     case SVt_PVBM:
5557         del_XPVBM(SvANY(sv));
5558         break;
5559     case SVt_PVFM:
5560         del_XPVFM(SvANY(sv));
5561         break;
5562     case SVt_PVIO:
5563         del_XPVIO(SvANY(sv));
5564         break;
5565     }
5566     SvFLAGS(sv) &= SVf_BREAK;
5567     SvFLAGS(sv) |= SVTYPEMASK;
5568 }
5569
5570 /*
5571 =for apidoc sv_newref
5572
5573 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5574 instead.
5575
5576 =cut
5577 */
5578
5579 SV *
5580 Perl_sv_newref(pTHX_ SV *sv)
5581 {
5582     if (sv)
5583         (SvREFCNT(sv))++;
5584     return sv;
5585 }
5586
5587 /*
5588 =for apidoc sv_free
5589
5590 Decrement an SV's reference count, and if it drops to zero, call
5591 C<sv_clear> to invoke destructors and free up any memory used by
5592 the body; finally, deallocate the SV's head itself.
5593 Normally called via a wrapper macro C<SvREFCNT_dec>.
5594
5595 =cut
5596 */
5597
5598 void
5599 Perl_sv_free(pTHX_ SV *sv)
5600 {
5601     if (!sv)
5602         return;
5603     if (SvREFCNT(sv) == 0) {
5604         if (SvFLAGS(sv) & SVf_BREAK)
5605             /* this SV's refcnt has been artificially decremented to
5606              * trigger cleanup */
5607             return;
5608         if (PL_in_clean_all) /* All is fair */
5609             return;
5610         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5611             /* make sure SvREFCNT(sv)==0 happens very seldom */
5612             SvREFCNT(sv) = (~(U32)0)/2;
5613             return;
5614         }
5615         if (ckWARN_d(WARN_INTERNAL))
5616             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5617                         "Attempt to free unreferenced scalar: SV 0x%"UVxf,
5618                 PTR2UV(sv));
5619         return;
5620     }
5621     if (--(SvREFCNT(sv)) > 0)
5622         return;
5623     Perl_sv_free2(aTHX_ sv);
5624 }
5625
5626 void
5627 Perl_sv_free2(pTHX_ SV *sv)
5628 {
5629 #ifdef DEBUGGING
5630     if (SvTEMP(sv)) {
5631         if (ckWARN_d(WARN_DEBUGGING))
5632             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5633                         "Attempt to free temp prematurely: SV 0x%"UVxf,
5634                         PTR2UV(sv));
5635         return;
5636     }
5637 #endif
5638     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5639         /* make sure SvREFCNT(sv)==0 happens very seldom */
5640         SvREFCNT(sv) = (~(U32)0)/2;
5641         return;
5642     }
5643     sv_clear(sv);
5644     if (! SvREFCNT(sv))
5645         del_SV(sv);
5646 }
5647
5648 /*
5649 =for apidoc sv_len
5650
5651 Returns the length of the string in the SV. Handles magic and type
5652 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5653
5654 =cut
5655 */
5656
5657 STRLEN
5658 Perl_sv_len(pTHX_ register SV *sv)
5659 {
5660     STRLEN len;
5661
5662     if (!sv)
5663         return 0;
5664
5665     if (SvGMAGICAL(sv))
5666         len = mg_length(sv);
5667     else
5668         (void)SvPV(sv, len);
5669     return len;
5670 }
5671
5672 /*
5673 =for apidoc sv_len_utf8
5674
5675 Returns the number of characters in the string in an SV, counting wide
5676 UTF-8 bytes as a single character. Handles magic and type coercion.
5677
5678 =cut
5679 */
5680
5681 /*
5682  * The length is cached in PERL_UTF8_magic, in the mg_len field.  Also the
5683  * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5684  * (Note that the mg_len is not the length of the mg_ptr field.)
5685  *
5686  */
5687
5688 STRLEN
5689 Perl_sv_len_utf8(pTHX_ register SV *sv)
5690 {
5691     if (!sv)
5692         return 0;
5693
5694     if (SvGMAGICAL(sv))
5695         return mg_length(sv);
5696     else
5697     {
5698         STRLEN len, ulen;
5699         U8 *s = (U8*)SvPV(sv, len);
5700         MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5701
5702         if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5703             ulen = mg->mg_len;
5704 #ifdef PERL_UTF8_CACHE_ASSERT
5705             assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5706 #endif
5707         }
5708         else {
5709             ulen = Perl_utf8_length(aTHX_ s, s + len);
5710             if (!mg && !SvREADONLY(sv)) {
5711                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5712                 mg = mg_find(sv, PERL_MAGIC_utf8);
5713                 assert(mg);
5714             }
5715             if (mg)
5716                 mg->mg_len = ulen;
5717         }
5718         return ulen;
5719     }
5720 }
5721
5722 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5723  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5724  * between UTF-8 and byte offsets.  There are two (substr offset and substr
5725  * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5726  * and byte offset) cache positions.
5727  *
5728  * The mg_len field is used by sv_len_utf8(), see its comments.
5729  * Note that the mg_len is not the length of the mg_ptr field.
5730  *
5731  */
5732 STATIC bool
5733 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5734 {
5735     bool found = FALSE;
5736
5737     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5738         if (!*mgp) {
5739             sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5740             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5741         }
5742         assert(*mgp);
5743
5744         if ((*mgp)->mg_ptr)
5745             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5746         else {
5747             Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5748             (*mgp)->mg_ptr = (char *) *cachep;
5749         }
5750         assert(*cachep);
5751
5752         (*cachep)[i]   = *offsetp;
5753         (*cachep)[i+1] = s - start;
5754         found = TRUE;
5755     }
5756
5757     return found;
5758 }
5759
5760 /*
5761  * S_utf8_mg_pos() is used to query and update mg_ptr field of
5762  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5763  * between UTF-8 and byte offsets.  See also the comments of
5764  * S_utf8_mg_pos_init().
5765  *
5766  */
5767 STATIC bool
5768 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5769 {
5770     bool found = FALSE;
5771
5772     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5773         if (!*mgp)
5774             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5775         if (*mgp && (*mgp)->mg_ptr) {
5776             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5777             ASSERT_UTF8_CACHE(*cachep);
5778             if ((*cachep)[i] == (STRLEN)uoff)   /* An exact match. */
5779                  found = TRUE;
5780             else {                      /* We will skip to the right spot. */
5781                  STRLEN forw  = 0;
5782                  STRLEN backw = 0;
5783                  U8* p = NULL;
5784
5785                  /* The assumption is that going backward is half
5786                   * the speed of going forward (that's where the
5787                   * 2 * backw in the below comes from).  (The real
5788                   * figure of course depends on the UTF-8 data.) */
5789
5790                  if ((*cachep)[i] > (STRLEN)uoff) {
5791                       forw  = uoff;
5792                       backw = (*cachep)[i] - (STRLEN)uoff;
5793
5794                       if (forw < 2 * backw)
5795                            p = start;
5796                       else
5797                            p = start + (*cachep)[i+1];
5798                  }
5799                  /* Try this only for the substr offset (i == 0),
5800                   * not for the substr length (i == 2). */
5801                  else if (i == 0) { /* (*cachep)[i] < uoff */
5802                       STRLEN ulen = sv_len_utf8(sv);
5803
5804                       if ((STRLEN)uoff < ulen) {
5805                            forw  = (STRLEN)uoff - (*cachep)[i];
5806                            backw = ulen - (STRLEN)uoff;
5807
5808                            if (forw < 2 * backw)
5809                                 p = start + (*cachep)[i+1];
5810                            else
5811                                 p = send;
5812                       }
5813
5814                       /* If the string is not long enough for uoff,
5815                        * we could extend it, but not at this low a level. */
5816                  }
5817
5818                  if (p) {
5819                       if (forw < 2 * backw) {
5820                            while (forw--)
5821                                 p += UTF8SKIP(p);
5822                       }
5823                       else {
5824                            while (backw--) {
5825                                 p--;
5826                                 while (UTF8_IS_CONTINUATION(*p))
5827                                      p--;
5828                            }
5829                       }
5830
5831                       /* Update the cache. */
5832                       (*cachep)[i]   = (STRLEN)uoff;
5833                       (*cachep)[i+1] = p - start;
5834
5835                       found = TRUE;
5836                  }
5837             }
5838             if (found) {        /* Setup the return values. */
5839                  *offsetp = (*cachep)[i+1];
5840                  *sp = start + *offsetp;
5841                  if (*sp >= send) {
5842                       *sp = send;
5843                       *offsetp = send - start;
5844                  }
5845                  else if (*sp < start) {
5846                       *sp = start;
5847                       *offsetp = 0;
5848                  }
5849             }
5850         }
5851 #ifdef PERL_UTF8_CACHE_ASSERT
5852         if (found) {
5853              U8 *s = start;
5854              I32 n = uoff;
5855
5856              while (n-- && s < send)
5857                   s += UTF8SKIP(s);
5858
5859              if (i == 0) {
5860                   assert(*offsetp == s - start);
5861                   assert((*cachep)[0] == (STRLEN)uoff);
5862                   assert((*cachep)[1] == *offsetp);
5863              }
5864              ASSERT_UTF8_CACHE(*cachep);
5865         }
5866 #endif
5867     }
5868
5869     return found;
5870 }
5871
5872 /*
5873 =for apidoc sv_pos_u2b
5874
5875 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5876 the start of the string, to a count of the equivalent number of bytes; if
5877 lenp is non-zero, it does the same to lenp, but this time starting from
5878 the offset, rather than from the start of the string. Handles magic and
5879 type coercion.
5880
5881 =cut
5882 */
5883
5884 /*
5885  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5886  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5887  * byte offsets.  See also the comments of S_utf8_mg_pos().
5888  *
5889  */
5890
5891 void
5892 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5893 {
5894     U8 *start;
5895     U8 *s;
5896     STRLEN len;
5897     STRLEN *cache = 0;
5898     STRLEN boffset = 0;
5899
5900     if (!sv)
5901         return;
5902
5903     start = s = (U8*)SvPV(sv, len);
5904     if (len) {
5905          I32 uoffset = *offsetp;
5906          U8 *send = s + len;
5907          MAGIC *mg = 0;
5908          bool found = FALSE;
5909
5910          if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5911              found = TRUE;
5912          if (!found && uoffset > 0) {
5913               while (s < send && uoffset--)
5914                    s += UTF8SKIP(s);
5915               if (s >= send)
5916                    s = send;
5917               if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5918                   boffset = cache[1];
5919               *offsetp = s - start;
5920          }
5921          if (lenp) {
5922               found = FALSE;
5923               start = s;
5924               if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5925                   *lenp -= boffset;
5926                   found = TRUE;
5927               }
5928               if (!found && *lenp > 0) {
5929                    I32 ulen = *lenp;
5930                    if (ulen > 0)
5931                         while (s < send && ulen--)
5932                              s += UTF8SKIP(s);
5933                    if (s >= send)
5934                         s = send;
5935                    if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5936                         cache[2] += *offsetp;
5937               }
5938               *lenp = s - start;
5939          }
5940          ASSERT_UTF8_CACHE(cache);
5941     }
5942     else {
5943          *offsetp = 0;
5944          if (lenp)
5945               *lenp = 0;
5946     }
5947
5948     return;
5949 }
5950
5951 /*
5952 =for apidoc sv_pos_b2u
5953
5954 Converts the value pointed to by offsetp from a count of bytes from the
5955 start of the string, to a count of the equivalent number of UTF-8 chars.
5956 Handles magic and type coercion.
5957
5958 =cut
5959 */
5960
5961 /*
5962  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5963  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5964  * byte offsets.  See also the comments of S_utf8_mg_pos().
5965  *
5966  */
5967
5968 void
5969 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5970 {
5971     U8* s;
5972     STRLEN len;
5973
5974     if (!sv)
5975         return;
5976
5977     s = (U8*)SvPV(sv, len);
5978     if ((I32)len < *offsetp)
5979         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5980     else {
5981         U8* send = s + *offsetp;
5982         MAGIC* mg = NULL;
5983         STRLEN *cache = NULL;
5984
5985         len = 0;
5986
5987         if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5988             mg = mg_find(sv, PERL_MAGIC_utf8);
5989             if (mg && mg->mg_ptr) {
5990                 cache = (STRLEN *) mg->mg_ptr;
5991                 if (cache[1] == (STRLEN)*offsetp) {
5992                     /* An exact match. */
5993                     *offsetp = cache[0];
5994
5995                     return;
5996                 }
5997                 else if (cache[1] < (STRLEN)*offsetp) {
5998                     /* We already know part of the way. */
5999                     len = cache[0];
6000                     s  += cache[1];
6001                     /* Let the below loop do the rest. */
6002                 }
6003                 else { /* cache[1] > *offsetp */
6004                     /* We already know all of the way, now we may
6005                      * be able to walk back.  The same assumption
6006                      * is made as in S_utf8_mg_pos(), namely that
6007                      * walking backward is twice slower than
6008                      * walking forward. */
6009                     STRLEN forw  = *offsetp;
6010                     STRLEN backw = cache[1] - *offsetp;
6011
6012                     if (!(forw < 2 * backw)) {
6013                         U8 *p = s + cache[1];
6014                         STRLEN ubackw = 0;
6015
6016                         cache[1] -= backw;
6017
6018                         while (backw--) {
6019                             p--;
6020                             while (UTF8_IS_CONTINUATION(*p)) {
6021                                 p--;
6022                                 backw--;
6023                             }
6024                             ubackw++;
6025                         }
6026
6027                         cache[0] -= ubackw;
6028                         *offsetp = cache[0];
6029                         return;
6030                     }
6031                 }
6032             }
6033             ASSERT_UTF8_CACHE(cache);
6034         }
6035
6036         while (s < send) {
6037             STRLEN n = 1;
6038
6039             /* Call utf8n_to_uvchr() to validate the sequence
6040              * (unless a simple non-UTF character) */
6041             if (!UTF8_IS_INVARIANT(*s))
6042                 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6043             if (n > 0) {
6044                 s += n;
6045                 len++;
6046             }
6047             else
6048                 break;
6049         }
6050
6051         if (!SvREADONLY(sv)) {
6052             if (!mg) {
6053                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6054                 mg = mg_find(sv, PERL_MAGIC_utf8);
6055             }
6056             assert(mg);
6057
6058             if (!mg->mg_ptr) {
6059                 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6060                 mg->mg_ptr = (char *) cache;
6061             }
6062             assert(cache);
6063
6064             cache[0] = len;
6065             cache[1] = *offsetp;
6066         }
6067
6068         *offsetp = len;
6069     }
6070     return;
6071 }
6072
6073 /*
6074 =for apidoc sv_eq
6075
6076 Returns a boolean indicating whether the strings in the two SVs are
6077 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6078 coerce its args to strings if necessary.
6079
6080 =cut
6081 */
6082
6083 I32
6084 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6085 {
6086     char *pv1;
6087     STRLEN cur1;
6088     char *pv2;
6089     STRLEN cur2;
6090     I32  eq     = 0;
6091     char *tpv   = Nullch;
6092     SV* svrecode = Nullsv;
6093
6094     if (!sv1) {
6095         pv1 = "";
6096         cur1 = 0;
6097     }
6098     else
6099         pv1 = SvPV(sv1, cur1);
6100
6101     if (!sv2){
6102         pv2 = "";
6103         cur2 = 0;
6104     }
6105     else
6106         pv2 = SvPV(sv2, cur2);
6107
6108     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6109         /* Differing utf8ness.
6110          * Do not UTF8size the comparands as a side-effect. */
6111          if (PL_encoding) {
6112               if (SvUTF8(sv1)) {
6113                    svrecode = newSVpvn(pv2, cur2);
6114                    sv_recode_to_utf8(svrecode, PL_encoding);
6115                    pv2 = SvPV(svrecode, cur2);
6116               }
6117               else {
6118                    svrecode = newSVpvn(pv1, cur1);
6119                    sv_recode_to_utf8(svrecode, PL_encoding);
6120                    pv1 = SvPV(svrecode, cur1);
6121               }
6122               /* Now both are in UTF-8. */
6123               if (cur1 != cur2)
6124                    return FALSE;
6125          }
6126          else {
6127               bool is_utf8 = TRUE;
6128
6129               if (SvUTF8(sv1)) {
6130                    /* sv1 is the UTF-8 one,
6131                     * if is equal it must be downgrade-able */
6132                    char *pv = (char*)bytes_from_utf8((U8*)pv1,
6133                                                      &cur1, &is_utf8);
6134                    if (pv != pv1)
6135                         pv1 = tpv = pv;
6136               }
6137               else {
6138                    /* sv2 is the UTF-8 one,
6139                     * if is equal it must be downgrade-able */
6140                    char *pv = (char *)bytes_from_utf8((U8*)pv2,
6141                                                       &cur2, &is_utf8);
6142                    if (pv != pv2)
6143                         pv2 = tpv = pv;
6144               }
6145               if (is_utf8) {
6146                    /* Downgrade not possible - cannot be eq */
6147                    return FALSE;
6148               }
6149          }
6150     }
6151
6152     if (cur1 == cur2)
6153         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6154
6155     if (svrecode)
6156          SvREFCNT_dec(svrecode);
6157
6158     if (tpv)
6159         Safefree(tpv);
6160
6161     return eq;
6162 }
6163
6164 /*
6165 =for apidoc sv_cmp
6166
6167 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
6168 string in C<sv1> is less than, equal to, or greater than the string in
6169 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6170 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
6171
6172 =cut
6173 */
6174
6175 I32
6176 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6177 {
6178     STRLEN cur1, cur2;
6179     char *pv1, *pv2, *tpv = Nullch;
6180     I32  cmp;
6181     SV *svrecode = Nullsv;
6182
6183     if (!sv1) {
6184         pv1 = "";
6185         cur1 = 0;
6186     }
6187     else
6188         pv1 = SvPV(sv1, cur1);
6189
6190     if (!sv2) {
6191         pv2 = "";
6192         cur2 = 0;
6193     }
6194     else
6195         pv2 = SvPV(sv2, cur2);
6196
6197     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6198         /* Differing utf8ness.
6199          * Do not UTF8size the comparands as a side-effect. */
6200         if (SvUTF8(sv1)) {
6201             if (PL_encoding) {
6202                  svrecode = newSVpvn(pv2, cur2);
6203                  sv_recode_to_utf8(svrecode, PL_encoding);
6204                  pv2 = SvPV(svrecode, cur2);
6205             }
6206             else {
6207                  pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6208             }
6209         }
6210         else {
6211             if (PL_encoding) {
6212                  svrecode = newSVpvn(pv1, cur1);
6213                  sv_recode_to_utf8(svrecode, PL_encoding);
6214                  pv1 = SvPV(svrecode, cur1);
6215             }
6216             else {
6217                  pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6218             }
6219         }
6220     }
6221
6222     if (!cur1) {
6223         cmp = cur2 ? -1 : 0;
6224     } else if (!cur2) {
6225         cmp = 1;
6226     } else {
6227         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6228
6229         if (retval) {
6230             cmp = retval < 0 ? -1 : 1;
6231         } else if (cur1 == cur2) {
6232             cmp = 0;
6233         } else {
6234             cmp = cur1 < cur2 ? -1 : 1;
6235         }
6236     }
6237
6238     if (svrecode)
6239          SvREFCNT_dec(svrecode);
6240
6241     if (tpv)
6242         Safefree(tpv);
6243
6244     return cmp;
6245 }
6246
6247 /*
6248 =for apidoc sv_cmp_locale
6249
6250 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6251 'use bytes' aware, handles get magic, and will coerce its args to strings
6252 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
6253
6254 =cut
6255 */
6256
6257 I32
6258 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6259 {
6260 #ifdef USE_LOCALE_COLLATE
6261
6262     char *pv1, *pv2;
6263     STRLEN len1, len2;
6264     I32 retval;
6265
6266     if (PL_collation_standard)
6267         goto raw_compare;
6268
6269     len1 = 0;
6270     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6271     len2 = 0;
6272     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6273
6274     if (!pv1 || !len1) {
6275         if (pv2 && len2)
6276             return -1;
6277         else
6278             goto raw_compare;
6279     }
6280     else {
6281         if (!pv2 || !len2)
6282             return 1;
6283     }
6284
6285     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6286
6287     if (retval)
6288         return retval < 0 ? -1 : 1;
6289
6290     /*
6291      * When the result of collation is equality, that doesn't mean
6292      * that there are no differences -- some locales exclude some
6293      * characters from consideration.  So to avoid false equalities,
6294      * we use the raw string as a tiebreaker.
6295      */
6296
6297   raw_compare:
6298     /* FALL THROUGH */
6299
6300 #endif /* USE_LOCALE_COLLATE */
6301
6302     return sv_cmp(sv1, sv2);
6303 }
6304
6305
6306 #ifdef USE_LOCALE_COLLATE
6307
6308 /*
6309 =for apidoc sv_collxfrm
6310
6311 Add Collate Transform magic to an SV if it doesn't already have it.
6312
6313 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6314 scalar data of the variable, but transformed to such a format that a normal
6315 memory comparison can be used to compare the data according to the locale
6316 settings.
6317
6318 =cut
6319 */
6320
6321 char *
6322 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6323 {
6324     MAGIC *mg;
6325
6326     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6327     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6328         char *s, *xf;
6329         STRLEN len, xlen;
6330
6331         if (mg)
6332             Safefree(mg->mg_ptr);
6333         s = SvPV(sv, len);
6334         if ((xf = mem_collxfrm(s, len, &xlen))) {
6335             if (SvREADONLY(sv)) {
6336                 SAVEFREEPV(xf);
6337                 *nxp = xlen;
6338                 return xf + sizeof(PL_collation_ix);
6339             }
6340             if (! mg) {
6341                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6342                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6343                 assert(mg);
6344             }
6345             mg->mg_ptr = xf;
6346             mg->mg_len = xlen;
6347         }
6348         else {
6349             if (mg) {
6350                 mg->mg_ptr = NULL;
6351                 mg->mg_len = -1;
6352             }
6353         }
6354     }
6355     if (mg && mg->mg_ptr) {
6356         *nxp = mg->mg_len;
6357         return mg->mg_ptr + sizeof(PL_collation_ix);
6358     }
6359     else {
6360         *nxp = 0;
6361         return NULL;
6362     }
6363 }
6364
6365 #endif /* USE_LOCALE_COLLATE */
6366
6367 /*
6368 =for apidoc sv_gets
6369
6370 Get a line from the filehandle and store it into the SV, optionally
6371 appending to the currently-stored string.
6372
6373 =cut
6374 */
6375
6376 char *
6377 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6378 {
6379     char *rsptr;
6380     STRLEN rslen;
6381     register STDCHAR rslast;
6382     register STDCHAR *bp;
6383     register I32 cnt;
6384     I32 i = 0;
6385     I32 rspara = 0;
6386     I32 recsize;
6387
6388     if (SvTHINKFIRST(sv))
6389         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6390     /* XXX. If you make this PVIV, then copy on write can copy scalars read
6391        from <>.
6392        However, perlbench says it's slower, because the existing swipe code
6393        is faster than copy on write.
6394        Swings and roundabouts.  */
6395     (void)SvUPGRADE(sv, SVt_PV);
6396
6397     SvSCREAM_off(sv);
6398
6399     if (append) {
6400         if (PerlIO_isutf8(fp)) {
6401             if (!SvUTF8(sv)) {
6402                 sv_utf8_upgrade_nomg(sv);
6403                 sv_pos_u2b(sv,&append,0);
6404             }
6405         } else if (SvUTF8(sv)) {
6406             SV *tsv = NEWSV(0,0);
6407             sv_gets(tsv, fp, 0);
6408             sv_utf8_upgrade_nomg(tsv);
6409             SvCUR_set(sv,append);
6410             sv_catsv(sv,tsv);
6411             sv_free(tsv);
6412             goto return_string_or_null;
6413         }
6414     }
6415
6416     SvPOK_only(sv);
6417     if (PerlIO_isutf8(fp))
6418         SvUTF8_on(sv);
6419
6420     if (IN_PERL_COMPILETIME) {
6421         /* we always read code in line mode */
6422         rsptr = "\n";
6423         rslen = 1;
6424     }
6425     else if (RsSNARF(PL_rs)) {
6426         /* If it is a regular disk file use size from stat() as estimate
6427            of amount we are going to read - may result in malloc-ing
6428            more memory than we realy need if layers bellow reduce
6429            size we read (e.g. CRLF or a gzip layer)
6430          */
6431         Stat_t st;
6432         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
6433             Off_t offset = PerlIO_tell(fp);
6434             if (offset != (Off_t) -1 && st.st_size + append > offset) {
6435                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6436             }
6437         }
6438         rsptr = NULL;
6439         rslen = 0;
6440     }
6441     else if (RsRECORD(PL_rs)) {
6442       I32 bytesread;
6443       char *buffer;
6444
6445       /* Grab the size of the record we're getting */
6446       recsize = SvIV(SvRV(PL_rs));
6447       buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6448       /* Go yank in */
6449 #ifdef VMS
6450       /* VMS wants read instead of fread, because fread doesn't respect */
6451       /* RMS record boundaries. This is not necessarily a good thing to be */
6452       /* doing, but we've got no other real choice - except avoid stdio
6453          as implementation - perhaps write a :vms layer ?
6454        */
6455       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6456 #else
6457       bytesread = PerlIO_read(fp, buffer, recsize);
6458 #endif
6459       if (bytesread < 0)
6460           bytesread = 0;
6461       SvCUR_set(sv, bytesread += append);
6462       buffer[bytesread] = '\0';
6463       goto return_string_or_null;
6464     }
6465     else if (RsPARA(PL_rs)) {
6466         rsptr = "\n\n";
6467         rslen = 2;
6468         rspara = 1;
6469     }
6470     else {
6471         /* Get $/ i.e. PL_rs into same encoding as stream wants */
6472         if (PerlIO_isutf8(fp)) {
6473             rsptr = SvPVutf8(PL_rs, rslen);
6474         }
6475         else {
6476             if (SvUTF8(PL_rs)) {
6477                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6478                     Perl_croak(aTHX_ "Wide character in $/");
6479                 }
6480             }
6481             rsptr = SvPV(PL_rs, rslen);
6482         }
6483     }
6484
6485     rslast = rslen ? rsptr[rslen - 1] : '\0';
6486
6487     if (rspara) {               /* have to do this both before and after */
6488         do {                    /* to make sure file boundaries work right */
6489             if (PerlIO_eof(fp))
6490                 return 0;
6491             i = PerlIO_getc(fp);
6492             if (i != '\n') {
6493                 if (i == -1)
6494                     return 0;
6495                 PerlIO_ungetc(fp,i);
6496                 break;
6497             }
6498         } while (i != EOF);
6499     }
6500
6501     /* See if we know enough about I/O mechanism to cheat it ! */
6502
6503     /* This used to be #ifdef test - it is made run-time test for ease
6504        of abstracting out stdio interface. One call should be cheap
6505        enough here - and may even be a macro allowing compile
6506        time optimization.
6507      */
6508
6509     if (PerlIO_fast_gets(fp)) {
6510
6511     /*
6512      * We're going to steal some values from the stdio struct
6513      * and put EVERYTHING in the innermost loop into registers.
6514      */
6515     register STDCHAR *ptr;
6516     STRLEN bpx;
6517     I32 shortbuffered;
6518
6519 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6520     /* An ungetc()d char is handled separately from the regular
6521      * buffer, so we getc() it back out and stuff it in the buffer.
6522      */
6523     i = PerlIO_getc(fp);
6524     if (i == EOF) return 0;
6525     *(--((*fp)->_ptr)) = (unsigned char) i;
6526     (*fp)->_cnt++;
6527 #endif
6528
6529     /* Here is some breathtakingly efficient cheating */
6530
6531     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
6532     /* make sure we have the room */
6533     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6534         /* Not room for all of it
6535            if we are looking for a separator and room for some
6536          */
6537         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6538             /* just process what we have room for */
6539             shortbuffered = cnt - SvLEN(sv) + append + 1;
6540             cnt -= shortbuffered;
6541         }
6542         else {
6543             shortbuffered = 0;
6544             /* remember that cnt can be negative */
6545             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6546         }
6547     }
6548     else
6549         shortbuffered = 0;
6550     bp = (STDCHAR*)SvPVX(sv) + append;  /* move these two too to registers */
6551     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6552     DEBUG_P(PerlIO_printf(Perl_debug_log,
6553         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6554     DEBUG_P(PerlIO_printf(Perl_debug_log,
6555         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6556                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6557                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6558     for (;;) {
6559       screamer:
6560         if (cnt > 0) {
6561             if (rslen) {
6562                 while (cnt > 0) {                    /* this     |  eat */
6563                     cnt--;
6564                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
6565                         goto thats_all_folks;        /* screams  |  sed :-) */
6566                 }
6567             }
6568             else {
6569                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
6570                 bp += cnt;                           /* screams  |  dust */
6571                 ptr += cnt;                          /* louder   |  sed :-) */
6572                 cnt = 0;
6573             }
6574         }
6575
6576         if (shortbuffered) {            /* oh well, must extend */
6577             cnt = shortbuffered;
6578             shortbuffered = 0;
6579             bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6580             SvCUR_set(sv, bpx);
6581             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6582             bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6583             continue;
6584         }
6585
6586         DEBUG_P(PerlIO_printf(Perl_debug_log,
6587                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6588                               PTR2UV(ptr),(long)cnt));
6589         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6590 #if 0
6591         DEBUG_P(PerlIO_printf(Perl_debug_log,
6592             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6593             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6594             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6595 #endif
6596         /* This used to call 'filbuf' in stdio form, but as that behaves like
6597            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6598            another abstraction.  */
6599         i   = PerlIO_getc(fp);          /* get more characters */
6600 #if 0
6601         DEBUG_P(PerlIO_printf(Perl_debug_log,
6602             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6603             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6604             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6605 #endif
6606         cnt = PerlIO_get_cnt(fp);
6607         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
6608         DEBUG_P(PerlIO_printf(Perl_debug_log,
6609             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6610
6611         if (i == EOF)                   /* all done for ever? */
6612             goto thats_really_all_folks;
6613
6614         bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6615         SvCUR_set(sv, bpx);
6616         SvGROW(sv, bpx + cnt + 2);
6617         bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6618
6619         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
6620
6621         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
6622             goto thats_all_folks;
6623     }
6624
6625 thats_all_folks:
6626     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6627           memNE((char*)bp - rslen, rsptr, rslen))
6628         goto screamer;                          /* go back to the fray */
6629 thats_really_all_folks:
6630     if (shortbuffered)
6631         cnt += shortbuffered;
6632         DEBUG_P(PerlIO_printf(Perl_debug_log,
6633             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6634     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
6635     DEBUG_P(PerlIO_printf(Perl_debug_log,
6636         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6637         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6638         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6639     *bp = '\0';
6640     SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv));    /* set length */
6641     DEBUG_P(PerlIO_printf(Perl_debug_log,
6642         "Screamer: done, len=%ld, string=|%.*s|\n",
6643         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6644     }
6645    else
6646     {
6647        /*The big, slow, and stupid way. */
6648
6649       /* Any stack-challenged places. */
6650 #if defined(EPOC)
6651       /* EPOC: need to work around SDK features.         *
6652        * On WINS: MS VC5 generates calls to _chkstk,     *
6653        * if a "large" stack frame is allocated.          *
6654        * gcc on MARM does not generate calls like these. */
6655 #   define USEHEAPINSTEADOFSTACK
6656 #endif
6657
6658 #ifdef USEHEAPINSTEADOFSTACK
6659         STDCHAR *buf = 0;
6660         New(0, buf, 8192, STDCHAR);
6661         assert(buf);
6662 #else
6663         STDCHAR buf[8192];
6664 #endif
6665
6666 screamer2:
6667         if (rslen) {
6668             register STDCHAR *bpe = buf + sizeof(buf);
6669             bp = buf;
6670             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6671                 ; /* keep reading */
6672             cnt = bp - buf;
6673         }
6674         else {
6675             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6676             /* Accomodate broken VAXC compiler, which applies U8 cast to
6677              * both args of ?: operator, causing EOF to change into 255
6678              */
6679             if (cnt > 0)
6680                  i = (U8)buf[cnt - 1];
6681             else
6682                  i = EOF;
6683         }
6684
6685         if (cnt < 0)
6686             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
6687         if (append)
6688              sv_catpvn(sv, (char *) buf, cnt);
6689         else
6690              sv_setpvn(sv, (char *) buf, cnt);
6691
6692         if (i != EOF &&                 /* joy */
6693             (!rslen ||
6694              SvCUR(sv) < rslen ||
6695              memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6696         {
6697             append = -1;
6698             /*
6699              * If we're reading from a TTY and we get a short read,
6700              * indicating that the user hit his EOF character, we need
6701              * to notice it now, because if we try to read from the TTY
6702              * again, the EOF condition will disappear.
6703              *
6704              * The comparison of cnt to sizeof(buf) is an optimization
6705              * that prevents unnecessary calls to feof().
6706              *
6707              * - jik 9/25/96
6708              */
6709             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6710                 goto screamer2;
6711         }
6712
6713 #ifdef USEHEAPINSTEADOFSTACK
6714         Safefree(buf);
6715 #endif
6716     }
6717
6718     if (rspara) {               /* have to do this both before and after */
6719         while (i != EOF) {      /* to make sure file boundaries work right */
6720             i = PerlIO_getc(fp);
6721             if (i != '\n') {
6722                 PerlIO_ungetc(fp,i);
6723                 break;
6724             }
6725         }
6726     }
6727
6728 return_string_or_null:
6729     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6730 }
6731
6732 /*
6733 =for apidoc sv_inc
6734
6735 Auto-increment of the value in the SV, doing string to numeric conversion
6736 if necessary. Handles 'get' magic.
6737
6738 =cut
6739 */
6740
6741 void
6742 Perl_sv_inc(pTHX_ register SV *sv)
6743 {
6744     register char *d;
6745     int flags;
6746
6747     if (!sv)
6748         return;
6749     if (SvGMAGICAL(sv))
6750         mg_get(sv);
6751     if (SvTHINKFIRST(sv)) {
6752         if (SvIsCOW(sv))
6753             sv_force_normal_flags(sv, 0);
6754         if (SvREADONLY(sv)) {
6755             if (IN_PERL_RUNTIME)
6756                 Perl_croak(aTHX_ PL_no_modify);
6757         }
6758         if (SvROK(sv)) {
6759             IV i;
6760             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6761                 return;
6762             i = PTR2IV(SvRV(sv));
6763             sv_unref(sv);
6764             sv_setiv(sv, i);
6765         }
6766     }
6767     flags = SvFLAGS(sv);
6768     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6769         /* It's (privately or publicly) a float, but not tested as an
6770            integer, so test it to see. */
6771         (void) SvIV(sv);
6772         flags = SvFLAGS(sv);
6773     }
6774     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6775         /* It's publicly an integer, or privately an integer-not-float */
6776 #ifdef PERL_PRESERVE_IVUV
6777       oops_its_int:
6778 #endif
6779         if (SvIsUV(sv)) {
6780             if (SvUVX(sv) == UV_MAX)
6781                 sv_setnv(sv, UV_MAX_P1);
6782             else
6783                 (void)SvIOK_only_UV(sv);
6784                 ++SvUVX(sv);
6785         } else {
6786             if (SvIVX(sv) == IV_MAX)
6787                 sv_setuv(sv, (UV)IV_MAX + 1);
6788             else {
6789                 (void)SvIOK_only(sv);
6790                 ++SvIVX(sv);
6791             }
6792         }
6793         return;
6794     }
6795     if (flags & SVp_NOK) {
6796         (void)SvNOK_only(sv);
6797         SvNVX(sv) += 1.0;
6798         return;
6799     }
6800
6801     if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6802         if ((flags & SVTYPEMASK) < SVt_PVIV)
6803             sv_upgrade(sv, SVt_IV);
6804         (void)SvIOK_only(sv);
6805         SvIVX(sv) = 1;
6806         return;
6807     }
6808     d = SvPVX(sv);
6809     while (isALPHA(*d)) d++;
6810     while (isDIGIT(*d)) d++;
6811     if (*d) {
6812 #ifdef PERL_PRESERVE_IVUV
6813         /* Got to punt this as an integer if needs be, but we don't issue
6814            warnings. Probably ought to make the sv_iv_please() that does
6815            the conversion if possible, and silently.  */
6816         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6817         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6818             /* Need to try really hard to see if it's an integer.
6819                9.22337203685478e+18 is an integer.
6820                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6821                so $a="9.22337203685478e+18"; $a+0; $a++
6822                needs to be the same as $a="9.22337203685478e+18"; $a++
6823                or we go insane. */
6824
6825             (void) sv_2iv(sv);
6826             if (SvIOK(sv))
6827                 goto oops_its_int;
6828
6829             /* sv_2iv *should* have made this an NV */
6830             if (flags & SVp_NOK) {
6831                 (void)SvNOK_only(sv);
6832                 SvNVX(sv) += 1.0;
6833                 return;
6834             }
6835             /* I don't think we can get here. Maybe I should assert this
6836                And if we do get here I suspect that sv_setnv will croak. NWC
6837                Fall through. */
6838 #if defined(USE_LONG_DOUBLE)
6839             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6840                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6841 #else
6842             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6843                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6844 #endif
6845         }
6846 #endif /* PERL_PRESERVE_IVUV */
6847         sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6848         return;
6849     }
6850     d--;
6851     while (d >= SvPVX(sv)) {
6852         if (isDIGIT(*d)) {
6853             if (++*d <= '9')
6854                 return;
6855             *(d--) = '0';
6856         }
6857         else {
6858 #ifdef EBCDIC
6859             /* MKS: The original code here died if letters weren't consecutive.
6860              * at least it didn't have to worry about non-C locales.  The
6861              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6862              * arranged in order (although not consecutively) and that only
6863              * [A-Za-z] are accepted by isALPHA in the C locale.
6864              */
6865             if (*d != 'z' && *d != 'Z') {
6866                 do { ++*d; } while (!isALPHA(*d));
6867                 return;
6868             }
6869             *(d--) -= 'z' - 'a';
6870 #else
6871             ++*d;
6872             if (isALPHA(*d))
6873                 return;
6874             *(d--) -= 'z' - 'a' + 1;
6875 #endif
6876         }
6877     }
6878     /* oh,oh, the number grew */
6879     SvGROW(sv, SvCUR(sv) + 2);
6880     SvCUR(sv)++;
6881     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6882         *d = d[-1];
6883     if (isDIGIT(d[1]))
6884         *d = '1';
6885     else
6886         *d = d[1];
6887 }
6888
6889 /*
6890 =for apidoc sv_dec
6891
6892 Auto-decrement of the value in the SV, doing string to numeric conversion
6893 if necessary. Handles 'get' magic.
6894
6895 =cut
6896 */
6897
6898 void
6899 Perl_sv_dec(pTHX_ register SV *sv)
6900 {
6901     int flags;
6902
6903     if (!sv)
6904         return;
6905     if (SvGMAGICAL(sv))
6906         mg_get(sv);
6907     if (SvTHINKFIRST(sv)) {
6908         if (SvIsCOW(sv))
6909             sv_force_normal_flags(sv, 0);
6910         if (SvREADONLY(sv)) {
6911             if (IN_PERL_RUNTIME)
6912                 Perl_croak(aTHX_ PL_no_modify);
6913         }
6914         if (SvROK(sv)) {
6915             IV i;
6916             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6917                 return;
6918             i = PTR2IV(SvRV(sv));
6919             sv_unref(sv);
6920             sv_setiv(sv, i);
6921         }
6922     }
6923     /* Unlike sv_inc we don't have to worry about string-never-numbers
6924        and keeping them magic. But we mustn't warn on punting */
6925     flags = SvFLAGS(sv);
6926     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6927         /* It's publicly an integer, or privately an integer-not-float */
6928 #ifdef PERL_PRESERVE_IVUV
6929       oops_its_int:
6930 #endif
6931         if (SvIsUV(sv)) {
6932             if (SvUVX(sv) == 0) {
6933                 (void)SvIOK_only(sv);
6934                 SvIVX(sv) = -1;
6935             }
6936             else {
6937                 (void)SvIOK_only_UV(sv);
6938                 --SvUVX(sv);
6939             }
6940         } else {
6941             if (SvIVX(sv) == IV_MIN)
6942                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6943             else {
6944                 (void)SvIOK_only(sv);
6945                 --SvIVX(sv);
6946             }
6947         }
6948         return;
6949     }
6950     if (flags & SVp_NOK) {
6951         SvNVX(sv) -= 1.0;
6952         (void)SvNOK_only(sv);
6953         return;
6954     }
6955     if (!(flags & SVp_POK)) {
6956         if ((flags & SVTYPEMASK) < SVt_PVNV)
6957             sv_upgrade(sv, SVt_NV);
6958         SvNVX(sv) = -1.0;
6959         (void)SvNOK_only(sv);
6960         return;
6961     }
6962 #ifdef PERL_PRESERVE_IVUV
6963     {
6964         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6965         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6966             /* Need to try really hard to see if it's an integer.
6967                9.22337203685478e+18 is an integer.
6968                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6969                so $a="9.22337203685478e+18"; $a+0; $a--
6970                needs to be the same as $a="9.22337203685478e+18"; $a--
6971                or we go insane. */
6972
6973             (void) sv_2iv(sv);
6974             if (SvIOK(sv))
6975                 goto oops_its_int;
6976
6977             /* sv_2iv *should* have made this an NV */
6978             if (flags & SVp_NOK) {
6979                 (void)SvNOK_only(sv);
6980                 SvNVX(sv) -= 1.0;
6981                 return;
6982             }
6983             /* I don't think we can get here. Maybe I should assert this
6984                And if we do get here I suspect that sv_setnv will croak. NWC
6985                Fall through. */
6986 #if defined(USE_LONG_DOUBLE)
6987             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6988                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6989 #else
6990             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6991                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6992 #endif
6993         }
6994     }
6995 #endif /* PERL_PRESERVE_IVUV */
6996     sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6997 }
6998
6999 /*
7000 =for apidoc sv_mortalcopy
7001
7002 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7003 The new SV is marked as mortal. It will be destroyed "soon", either by an
7004 explicit call to FREETMPS, or by an implicit call at places such as
7005 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
7006
7007 =cut
7008 */
7009
7010 /* Make a string that will exist for the duration of the expression
7011  * evaluation.  Actually, it may have to last longer than that, but
7012  * hopefully we won't free it until it has been assigned to a
7013  * permanent location. */
7014
7015 SV *
7016 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7017 {
7018     register SV *sv;
7019
7020     new_SV(sv);
7021     sv_setsv(sv,oldstr);
7022     EXTEND_MORTAL(1);
7023     PL_tmps_stack[++PL_tmps_ix] = sv;
7024     SvTEMP_on(sv);
7025     return sv;
7026 }
7027
7028 /*
7029 =for apidoc sv_newmortal
7030
7031 Creates a new null SV which is mortal.  The reference count of the SV is
7032 set to 1. It will be destroyed "soon", either by an explicit call to
7033 FREETMPS, or by an implicit call at places such as statement boundaries.
7034 See also C<sv_mortalcopy> and C<sv_2mortal>.
7035
7036 =cut
7037 */
7038
7039 SV *
7040 Perl_sv_newmortal(pTHX)
7041 {
7042     register SV *sv;
7043
7044     new_SV(sv);
7045     SvFLAGS(sv) = SVs_TEMP;
7046     EXTEND_MORTAL(1);
7047     PL_tmps_stack[++PL_tmps_ix] = sv;
7048     return sv;
7049 }
7050
7051 /*
7052 =for apidoc sv_2mortal
7053
7054 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
7055 by an explicit call to FREETMPS, or by an implicit call at places such as
7056 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
7057
7058 =cut
7059 */
7060
7061 SV *
7062 Perl_sv_2mortal(pTHX_ register SV *sv)
7063 {
7064     if (!sv)
7065         return sv;
7066     if (SvREADONLY(sv) && SvIMMORTAL(sv))
7067         return sv;
7068     EXTEND_MORTAL(1);
7069     PL_tmps_stack[++PL_tmps_ix] = sv;
7070     SvTEMP_on(sv);
7071     return sv;
7072 }
7073
7074 /*
7075 =for apidoc newSVpv
7076
7077 Creates a new SV and copies a string into it.  The reference count for the
7078 SV is set to 1.  If C<len> is zero, Perl will compute the length using
7079 strlen().  For efficiency, consider using C<newSVpvn> instead.
7080
7081 =cut
7082 */
7083
7084 SV *
7085 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7086 {
7087     register SV *sv;
7088
7089     new_SV(sv);
7090     if (!len)
7091         len = strlen(s);
7092     sv_setpvn(sv,s,len);
7093     return sv;
7094 }
7095
7096 /*
7097 =for apidoc newSVpvn
7098
7099 Creates a new SV and copies a string into it.  The reference count for the
7100 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
7101 string.  You are responsible for ensuring that the source string is at least
7102 C<len> bytes long.
7103
7104 =cut
7105 */
7106
7107 SV *
7108 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7109 {
7110     register SV *sv;
7111
7112     new_SV(sv);
7113     sv_setpvn(sv,s,len);
7114     return sv;
7115 }
7116
7117 /*
7118 =for apidoc newSVpvn_share
7119
7120 Creates a new SV with its SvPVX pointing to a shared string in the string
7121 table. If the string does not already exist in the table, it is created
7122 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
7123 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7124 otherwise the hash is computed.  The idea here is that as the string table
7125 is used for shared hash keys these strings will have SvPVX == HeKEY and
7126 hash lookup will avoid string compare.
7127
7128 =cut
7129 */
7130
7131 SV *
7132 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7133 {
7134     register SV *sv;
7135     bool is_utf8 = FALSE;
7136     if (len < 0) {
7137         STRLEN tmplen = -len;
7138         is_utf8 = TRUE;
7139         /* See the note in hv.c:hv_fetch() --jhi */
7140         src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7141         len = tmplen;
7142     }
7143     if (!hash)
7144         PERL_HASH(hash, src, len);
7145     new_SV(sv);
7146     sv_upgrade(sv, SVt_PVIV);
7147     SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7148     SvCUR(sv) = len;
7149     SvUVX(sv) = hash;
7150     SvLEN(sv) = 0;
7151     SvREADONLY_on(sv);
7152     SvFAKE_on(sv);
7153     SvPOK_on(sv);
7154     if (is_utf8)
7155         SvUTF8_on(sv);
7156     return sv;
7157 }
7158
7159
7160 #if defined(PERL_IMPLICIT_CONTEXT)
7161
7162 /* pTHX_ magic can't cope with varargs, so this is a no-context
7163  * version of the main function, (which may itself be aliased to us).
7164  * Don't access this version directly.
7165  */
7166
7167 SV *
7168 Perl_newSVpvf_nocontext(const char* pat, ...)
7169 {
7170     dTHX;
7171     register SV *sv;
7172     va_list args;
7173     va_start(args, pat);
7174     sv = vnewSVpvf(pat, &args);
7175     va_end(args);
7176     return sv;
7177 }
7178 #endif
7179
7180 /*
7181 =for apidoc newSVpvf
7182
7183 Creates a new SV and initializes it with the string formatted like
7184 C<sprintf>.
7185
7186 =cut
7187 */
7188
7189 SV *
7190 Perl_newSVpvf(pTHX_ const char* pat, ...)
7191 {
7192     register SV *sv;
7193     va_list args;
7194     va_start(args, pat);
7195     sv = vnewSVpvf(pat, &args);
7196     va_end(args);
7197     return sv;
7198 }
7199
7200 /* backend for newSVpvf() and newSVpvf_nocontext() */
7201
7202 SV *
7203 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7204 {
7205     register SV *sv;
7206     new_SV(sv);
7207     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7208     return sv;
7209 }
7210
7211 /*
7212 =for apidoc newSVnv
7213
7214 Creates a new SV and copies a floating point value into it.
7215 The reference count for the SV is set to 1.
7216
7217 =cut
7218 */
7219
7220 SV *
7221 Perl_newSVnv(pTHX_ NV n)
7222 {
7223     register SV *sv;
7224
7225     new_SV(sv);
7226     sv_setnv(sv,n);
7227     return sv;
7228 }
7229
7230 /*
7231 =for apidoc newSViv
7232
7233 Creates a new SV and copies an integer into it.  The reference count for the
7234 SV is set to 1.
7235
7236 =cut
7237 */
7238
7239 SV *
7240 Perl_newSViv(pTHX_ IV i)
7241 {
7242     register SV *sv;
7243
7244     new_SV(sv);
7245     sv_setiv(sv,i);
7246     return sv;
7247 }
7248
7249 /*
7250 =for apidoc newSVuv
7251
7252 Creates a new SV and copies an unsigned integer into it.
7253 The reference count for the SV is set to 1.
7254
7255 =cut
7256 */
7257
7258 SV *
7259 Perl_newSVuv(pTHX_ UV u)
7260 {
7261     register SV *sv;
7262
7263     new_SV(sv);
7264     sv_setuv(sv,u);
7265     return sv;
7266 }
7267
7268 /*
7269 =for apidoc newRV_noinc
7270
7271 Creates an RV wrapper for an SV.  The reference count for the original
7272 SV is B<not> incremented.
7273
7274 =cut
7275 */
7276
7277 SV *
7278 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7279 {
7280     register SV *sv;
7281
7282     new_SV(sv);
7283     sv_upgrade(sv, SVt_RV);
7284     SvTEMP_off(tmpRef);
7285     SvRV(sv) = tmpRef;
7286     SvROK_on(sv);
7287     return sv;
7288 }
7289
7290 /* newRV_inc is the official function name to use now.
7291  * newRV_inc is in fact #defined to newRV in sv.h
7292  */
7293
7294 SV *
7295 Perl_newRV(pTHX_ SV *tmpRef)
7296 {
7297     return newRV_noinc(SvREFCNT_inc(tmpRef));
7298 }
7299
7300 /*
7301 =for apidoc newSVsv
7302
7303 Creates a new SV which is an exact duplicate of the original SV.
7304 (Uses C<sv_setsv>).
7305
7306 =cut
7307 */
7308
7309 SV *
7310 Perl_newSVsv(pTHX_ register SV *old)
7311 {
7312     register SV *sv;
7313
7314     if (!old)
7315         return Nullsv;
7316     if (SvTYPE(old) == SVTYPEMASK) {
7317         if (ckWARN_d(WARN_INTERNAL))
7318             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7319         return Nullsv;
7320     }
7321     new_SV(sv);
7322     if (SvTEMP(old)) {
7323         SvTEMP_off(old);
7324         sv_setsv(sv,old);
7325         SvTEMP_on(old);
7326     }
7327     else
7328         sv_setsv(sv,old);
7329     return sv;
7330 }
7331
7332 /*
7333 =for apidoc sv_reset
7334
7335 Underlying implementation for the C<reset> Perl function.
7336 Note that the perl-level function is vaguely deprecated.
7337
7338 =cut
7339 */
7340
7341 void
7342 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7343 {
7344     register HE *entry;
7345     register GV *gv;
7346     register SV *sv;
7347     register I32 i;
7348     register PMOP *pm;
7349     register I32 max;
7350     char todo[PERL_UCHAR_MAX+1];
7351
7352     if (!stash)
7353         return;
7354
7355     if (!*s) {          /* reset ?? searches */
7356         for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7357             pm->op_pmdynflags &= ~PMdf_USED;
7358         }
7359         return;
7360     }
7361
7362     /* reset variables */
7363
7364     if (!HvARRAY(stash))
7365         return;
7366
7367     Zero(todo, 256, char);
7368     while (*s) {
7369         i = (unsigned char)*s;
7370         if (s[1] == '-') {
7371             s += 2;
7372         }
7373         max = (unsigned char)*s++;
7374         for ( ; i <= max; i++) {
7375             todo[i] = 1;
7376         }
7377         for (i = 0; i <= (I32) HvMAX(stash); i++) {
7378             for (entry = HvARRAY(stash)[i];
7379                  entry;
7380                  entry = HeNEXT(entry))
7381             {
7382                 if (!todo[(U8)*HeKEY(entry)])
7383                     continue;
7384                 gv = (GV*)HeVAL(entry);
7385                 sv = GvSV(gv);
7386                 if (SvTHINKFIRST(sv)) {
7387                     if (!SvREADONLY(sv) && SvROK(sv))
7388                         sv_unref(sv);
7389                     continue;
7390                 }
7391                 (void)SvOK_off(sv);
7392                 if (SvTYPE(sv) >= SVt_PV) {
7393                     SvCUR_set(sv, 0);
7394                     if (SvPVX(sv) != Nullch)
7395                         *SvPVX(sv) = '\0';
7396                     SvTAINT(sv);
7397                 }
7398                 if (GvAV(gv)) {
7399                     av_clear(GvAV(gv));
7400                 }
7401                 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7402                     hv_clear(GvHV(gv));
7403 #ifndef PERL_MICRO
7404 #ifdef USE_ENVIRON_ARRAY
7405                     if (gv == PL_envgv
7406 #  ifdef USE_ITHREADS
7407                         && PL_curinterp == aTHX
7408 #  endif
7409                     )
7410                     {
7411                         environ[0] = Nullch;
7412                     }
7413 #endif
7414 #endif /* !PERL_MICRO */
7415                 }
7416             }
7417         }
7418     }
7419 }
7420
7421 /*
7422 =for apidoc sv_2io
7423
7424 Using various gambits, try to get an IO from an SV: the IO slot if its a
7425 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7426 named after the PV if we're a string.
7427
7428 =cut
7429 */
7430
7431 IO*
7432 Perl_sv_2io(pTHX_ SV *sv)
7433 {
7434     IO* io;
7435     GV* gv;
7436     STRLEN n_a;
7437
7438     switch (SvTYPE(sv)) {
7439     case SVt_PVIO:
7440         io = (IO*)sv;
7441         break;
7442     case SVt_PVGV:
7443         gv = (GV*)sv;
7444         io = GvIO(gv);
7445         if (!io)
7446             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7447         break;
7448     default:
7449         if (!SvOK(sv))
7450             Perl_croak(aTHX_ PL_no_usym, "filehandle");
7451         if (SvROK(sv))
7452             return sv_2io(SvRV(sv));
7453         gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7454         if (gv)
7455             io = GvIO(gv);
7456         else
7457             io = 0;
7458         if (!io)
7459             Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7460         break;
7461     }
7462     return io;
7463 }
7464
7465 /*
7466 =for apidoc sv_2cv
7467
7468 Using various gambits, try to get a CV from an SV; in addition, try if
7469 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7470
7471 =cut
7472 */
7473
7474 CV *
7475 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7476 {
7477     GV *gv = Nullgv;
7478     CV *cv = Nullcv;
7479     STRLEN n_a;
7480
7481     if (!sv)
7482         return *gvp = Nullgv, Nullcv;
7483     switch (SvTYPE(sv)) {
7484     case SVt_PVCV:
7485         *st = CvSTASH(sv);
7486         *gvp = Nullgv;
7487         return (CV*)sv;
7488     case SVt_PVHV:
7489     case SVt_PVAV:
7490         *gvp = Nullgv;
7491         return Nullcv;
7492     case SVt_PVGV:
7493         gv = (GV*)sv;
7494         *gvp = gv;
7495         *st = GvESTASH(gv);
7496         goto fix_gv;
7497
7498     default:
7499         if (SvGMAGICAL(sv))
7500             mg_get(sv);
7501         if (SvROK(sv)) {
7502             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
7503             tryAMAGICunDEREF(to_cv);
7504
7505             sv = SvRV(sv);
7506             if (SvTYPE(sv) == SVt_PVCV) {
7507                 cv = (CV*)sv;
7508                 *gvp = Nullgv;
7509                 *st = CvSTASH(cv);
7510                 return cv;
7511             }
7512             else if(isGV(sv))
7513                 gv = (GV*)sv;
7514             else
7515                 Perl_croak(aTHX_ "Not a subroutine reference");
7516         }
7517         else if (isGV(sv))
7518             gv = (GV*)sv;
7519         else
7520             gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7521         *gvp = gv;
7522         if (!gv)
7523             return Nullcv;
7524         *st = GvESTASH(gv);
7525     fix_gv:
7526         if (lref && !GvCVu(gv)) {
7527             SV *tmpsv;
7528             ENTER;
7529             tmpsv = NEWSV(704,0);
7530             gv_efullname3(tmpsv, gv, Nullch);
7531             /* XXX this is probably not what they think they're getting.
7532              * It has the same effect as "sub name;", i.e. just a forward
7533              * declaration! */
7534             newSUB(start_subparse(FALSE, 0),
7535                    newSVOP(OP_CONST, 0, tmpsv),
7536                    Nullop,
7537                    Nullop);
7538             LEAVE;
7539             if (!GvCVu(gv))
7540                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7541                            sv);
7542         }
7543         return GvCVu(gv);
7544     }
7545 }
7546
7547 /*
7548 =for apidoc sv_true
7549
7550 Returns true if the SV has a true value by Perl's rules.
7551 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7552 instead use an in-line version.
7553
7554 =cut
7555 */
7556
7557 I32
7558 Perl_sv_true(pTHX_ register SV *sv)
7559 {
7560     if (!sv)
7561         return 0;
7562     if (SvPOK(sv)) {
7563         register XPV* tXpv;
7564         if ((tXpv = (XPV*)SvANY(sv)) &&
7565                 (tXpv->xpv_cur > 1 ||
7566                 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7567             return 1;
7568         else
7569             return 0;
7570     }
7571     else {
7572         if (SvIOK(sv))
7573             return SvIVX(sv) != 0;
7574         else {
7575             if (SvNOK(sv))
7576                 return SvNVX(sv) != 0.0;
7577             else
7578                 return sv_2bool(sv);
7579         }
7580     }
7581 }
7582
7583 /*
7584 =for apidoc sv_iv
7585
7586 A private implementation of the C<SvIVx> macro for compilers which can't
7587 cope with complex macro expressions. Always use the macro instead.
7588
7589 =cut
7590 */
7591
7592 IV
7593 Perl_sv_iv(pTHX_ register SV *sv)
7594 {
7595     if (SvIOK(sv)) {
7596         if (SvIsUV(sv))
7597             return (IV)SvUVX(sv);
7598         return SvIVX(sv);
7599     }
7600     return sv_2iv(sv);
7601 }
7602
7603 /*
7604 =for apidoc sv_uv
7605
7606 A private implementation of the C<SvUVx> macro for compilers which can't
7607 cope with complex macro expressions. Always use the macro instead.
7608
7609 =cut
7610 */
7611
7612 UV
7613 Perl_sv_uv(pTHX_ register SV *sv)
7614 {
7615     if (SvIOK(sv)) {
7616         if (SvIsUV(sv))
7617             return SvUVX(sv);
7618         return (UV)SvIVX(sv);
7619     }
7620     return sv_2uv(sv);
7621 }
7622
7623 /*
7624 =for apidoc sv_nv
7625
7626 A private implementation of the C<SvNVx> macro for compilers which can't
7627 cope with complex macro expressions. Always use the macro instead.
7628
7629 =cut
7630 */
7631
7632 NV
7633 Perl_sv_nv(pTHX_ register SV *sv)
7634 {
7635     if (SvNOK(sv))
7636         return SvNVX(sv);
7637     return sv_2nv(sv);
7638 }
7639
7640 /* sv_pv() is now a macro using SvPV_nolen();
7641  * this function provided for binary compatibility only
7642  */
7643
7644 char *
7645 Perl_sv_pv(pTHX_ SV *sv)
7646 {
7647     STRLEN n_a;
7648
7649     if (SvPOK(sv))
7650         return SvPVX(sv);
7651
7652     return sv_2pv(sv, &n_a);
7653 }
7654
7655 /*
7656 =for apidoc sv_pv
7657
7658 Use the C<SvPV_nolen> macro instead
7659
7660 =for apidoc sv_pvn
7661
7662 A private implementation of the C<SvPV> macro for compilers which can't
7663 cope with complex macro expressions. Always use the macro instead.
7664
7665 =cut
7666 */
7667
7668 char *
7669 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7670 {
7671     if (SvPOK(sv)) {
7672         *lp = SvCUR(sv);
7673         return SvPVX(sv);
7674     }
7675     return sv_2pv(sv, lp);
7676 }
7677
7678
7679 char *
7680 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7681 {
7682     if (SvPOK(sv)) {
7683         *lp = SvCUR(sv);
7684         return SvPVX(sv);
7685     }
7686     return sv_2pv_flags(sv, lp, 0);
7687 }
7688
7689 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7690  * this function provided for binary compatibility only
7691  */
7692
7693 char *
7694 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7695 {
7696     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7697 }
7698
7699 /*
7700 =for apidoc sv_pvn_force
7701
7702 Get a sensible string out of the SV somehow.
7703 A private implementation of the C<SvPV_force> macro for compilers which
7704 can't cope with complex macro expressions. Always use the macro instead.
7705
7706 =for apidoc sv_pvn_force_flags
7707
7708 Get a sensible string out of the SV somehow.
7709 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7710 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7711 implemented in terms of this function.
7712 You normally want to use the various wrapper macros instead: see
7713 C<SvPV_force> and C<SvPV_force_nomg>
7714
7715 =cut
7716 */
7717
7718 char *
7719 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7720 {
7721     char *s = NULL;
7722
7723     if (SvTHINKFIRST(sv) && !SvROK(sv))
7724         sv_force_normal_flags(sv, 0);
7725
7726     if (SvPOK(sv)) {
7727         *lp = SvCUR(sv);
7728     }
7729     else {
7730         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7731             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7732                 OP_NAME(PL_op));
7733         }
7734         else
7735             s = sv_2pv_flags(sv, lp, flags);
7736         if (s != SvPVX(sv)) {   /* Almost, but not quite, sv_setpvn() */
7737             STRLEN len = *lp;
7738
7739             if (SvROK(sv))
7740                 sv_unref(sv);
7741             (void)SvUPGRADE(sv, SVt_PV);                /* Never FALSE */
7742             SvGROW(sv, len + 1);
7743             Move(s,SvPVX(sv),len,char);
7744             SvCUR_set(sv, len);
7745             *SvEND(sv) = '\0';
7746         }
7747         if (!SvPOK(sv)) {
7748             SvPOK_on(sv);               /* validate pointer */
7749             SvTAINT(sv);
7750             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7751                                   PTR2UV(sv),SvPVX(sv)));
7752         }
7753     }
7754     return SvPVX(sv);
7755 }
7756
7757 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7758  * this function provided for binary compatibility only
7759  */
7760
7761 char *
7762 Perl_sv_pvbyte(pTHX_ SV *sv)
7763 {
7764     sv_utf8_downgrade(sv,0);
7765     return sv_pv(sv);
7766 }
7767
7768 /*
7769 =for apidoc sv_pvbyte
7770
7771 Use C<SvPVbyte_nolen> instead.
7772
7773 =for apidoc sv_pvbyten
7774
7775 A private implementation of the C<SvPVbyte> macro for compilers
7776 which can't cope with complex macro expressions. Always use the macro
7777 instead.
7778
7779 =cut
7780 */
7781
7782 char *
7783 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7784 {
7785     sv_utf8_downgrade(sv,0);
7786     return sv_pvn(sv,lp);
7787 }
7788
7789 /*
7790 =for apidoc sv_pvbyten_force
7791
7792 A private implementation of the C<SvPVbytex_force> macro for compilers
7793 which can't cope with complex macro expressions. Always use the macro
7794 instead.
7795
7796 =cut
7797 */
7798
7799 char *
7800 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7801 {
7802     sv_utf8_downgrade(sv,0);
7803     return sv_pvn_force(sv,lp);
7804 }
7805
7806 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7807  * this function provided for binary compatibility only
7808  */
7809
7810 char *
7811 Perl_sv_pvutf8(pTHX_ SV *sv)
7812 {
7813     sv_utf8_upgrade(sv);
7814     return sv_pv(sv);
7815 }
7816
7817 /*
7818 =for apidoc sv_pvutf8
7819
7820 Use the C<SvPVutf8_nolen> macro instead
7821
7822 =for apidoc sv_pvutf8n
7823
7824 A private implementation of the C<SvPVutf8> macro for compilers
7825 which can't cope with complex macro expressions. Always use the macro
7826 instead.
7827
7828 =cut
7829 */
7830
7831 char *
7832 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7833 {
7834     sv_utf8_upgrade(sv);
7835     return sv_pvn(sv,lp);
7836 }
7837
7838 /*
7839 =for apidoc sv_pvutf8n_force
7840
7841 A private implementation of the C<SvPVutf8_force> macro for compilers
7842 which can't cope with complex macro expressions. Always use the macro
7843 instead.
7844
7845 =cut
7846 */
7847
7848 char *
7849 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7850 {
7851     sv_utf8_upgrade(sv);
7852     return sv_pvn_force(sv,lp);
7853 }
7854
7855 /*
7856 =for apidoc sv_reftype
7857
7858 Returns a string describing what the SV is a reference to.
7859
7860 =cut
7861 */
7862
7863 char *
7864 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7865 {
7866     if (ob && SvOBJECT(sv)) {
7867         if (HvNAME(SvSTASH(sv)))
7868             return HvNAME(SvSTASH(sv));
7869         else
7870             return "__ANON__";
7871     }
7872     else {
7873         switch (SvTYPE(sv)) {
7874         case SVt_NULL:
7875         case SVt_IV:
7876         case SVt_NV:
7877         case SVt_RV:
7878         case SVt_PV:
7879         case SVt_PVIV:
7880         case SVt_PVNV:
7881         case SVt_PVMG:
7882         case SVt_PVBM:
7883                                 if (SvVOK(sv))
7884                                     return "VSTRING";
7885                                 if (SvROK(sv))
7886                                     return "REF";
7887                                 else
7888                                     return "SCALAR";
7889
7890         case SVt_PVLV:          return SvROK(sv) ? "REF"
7891                                 /* tied lvalues should appear to be
7892                                  * scalars for backwards compatitbility */
7893                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7894                                     ? "SCALAR" : "LVALUE";
7895         case SVt_PVAV:          return "ARRAY";
7896         case SVt_PVHV:          return "HASH";
7897         case SVt_PVCV:          return "CODE";
7898         case SVt_PVGV:          return "GLOB";
7899         case SVt_PVFM:          return "FORMAT";
7900         case SVt_PVIO:          return "IO";
7901         default:                return "UNKNOWN";
7902         }
7903     }
7904 }
7905
7906 /*
7907 =for apidoc sv_isobject
7908
7909 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7910 object.  If the SV is not an RV, or if the object is not blessed, then this
7911 will return false.
7912
7913 =cut
7914 */
7915
7916 int
7917 Perl_sv_isobject(pTHX_ SV *sv)
7918 {
7919     if (!sv)
7920         return 0;
7921     if (SvGMAGICAL(sv))
7922         mg_get(sv);
7923     if (!SvROK(sv))
7924         return 0;
7925     sv = (SV*)SvRV(sv);
7926     if (!SvOBJECT(sv))
7927         return 0;
7928     return 1;
7929 }
7930
7931 /*
7932 =for apidoc sv_isa
7933
7934 Returns a boolean indicating whether the SV is blessed into the specified
7935 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7936 an inheritance relationship.
7937
7938 =cut
7939 */
7940
7941 int
7942 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7943 {
7944     if (!sv)
7945         return 0;
7946     if (SvGMAGICAL(sv))
7947         mg_get(sv);
7948     if (!SvROK(sv))
7949         return 0;
7950     sv = (SV*)SvRV(sv);
7951     if (!SvOBJECT(sv))
7952         return 0;
7953     if (!HvNAME(SvSTASH(sv)))
7954         return 0;
7955
7956     return strEQ(HvNAME(SvSTASH(sv)), name);
7957 }
7958
7959 /*
7960 =for apidoc newSVrv
7961
7962 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7963 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7964 be blessed in the specified package.  The new SV is returned and its
7965 reference count is 1.
7966
7967 =cut
7968 */
7969
7970 SV*
7971 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7972 {
7973     SV *sv;
7974
7975     new_SV(sv);
7976
7977     SV_CHECK_THINKFIRST_COW_DROP(rv);
7978     SvAMAGIC_off(rv);
7979
7980     if (SvTYPE(rv) >= SVt_PVMG) {
7981         U32 refcnt = SvREFCNT(rv);
7982         SvREFCNT(rv) = 0;
7983         sv_clear(rv);
7984         SvFLAGS(rv) = 0;
7985         SvREFCNT(rv) = refcnt;
7986     }
7987
7988     if (SvTYPE(rv) < SVt_RV)
7989         sv_upgrade(rv, SVt_RV);
7990     else if (SvTYPE(rv) > SVt_RV) {
7991         (void)SvOOK_off(rv);
7992         if (SvPVX(rv) && SvLEN(rv))
7993             Safefree(SvPVX(rv));
7994         SvCUR_set(rv, 0);
7995         SvLEN_set(rv, 0);
7996     }
7997
7998     (void)SvOK_off(rv);
7999     SvRV(rv) = sv;
8000     SvROK_on(rv);
8001
8002     if (classname) {
8003         HV* stash = gv_stashpv(classname, TRUE);
8004         (void)sv_bless(rv, stash);
8005     }
8006     return sv;
8007 }
8008
8009 /*
8010 =for apidoc sv_setref_pv
8011
8012 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
8013 argument will be upgraded to an RV.  That RV will be modified to point to
8014 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8015 into the SV.  The C<classname> argument indicates the package for the
8016 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8017 will have a reference count of 1, and the RV will be returned.
8018
8019 Do not use with other Perl types such as HV, AV, SV, CV, because those
8020 objects will become corrupted by the pointer copy process.
8021
8022 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8023
8024 =cut
8025 */
8026
8027 SV*
8028 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8029 {
8030     if (!pv) {
8031         sv_setsv(rv, &PL_sv_undef);
8032         SvSETMAGIC(rv);
8033     }
8034     else
8035         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8036     return rv;
8037 }
8038
8039 /*
8040 =for apidoc sv_setref_iv
8041
8042 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
8043 argument will be upgraded to an RV.  That RV will be modified to point to
8044 the new SV.  The C<classname> argument indicates the package for the
8045 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8046 will have a reference count of 1, and the RV will be returned.
8047
8048 =cut
8049 */
8050
8051 SV*
8052 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8053 {
8054     sv_setiv(newSVrv(rv,classname), iv);
8055     return rv;
8056 }
8057
8058 /*
8059 =for apidoc sv_setref_uv
8060
8061 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
8062 argument will be upgraded to an RV.  That RV will be modified to point to
8063 the new SV.  The C<classname> argument indicates the package for the
8064 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8065 will have a reference count of 1, and the RV will be returned.
8066
8067 =cut
8068 */
8069
8070 SV*
8071 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8072 {
8073     sv_setuv(newSVrv(rv,classname), uv);
8074     return rv;
8075 }
8076
8077 /*
8078 =for apidoc sv_setref_nv
8079
8080 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
8081 argument will be upgraded to an RV.  That RV will be modified to point to
8082 the new SV.  The C<classname> argument indicates the package for the
8083 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8084 will have a reference count of 1, and the RV will be returned.
8085
8086 =cut
8087 */
8088
8089 SV*
8090 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8091 {
8092     sv_setnv(newSVrv(rv,classname), nv);
8093     return rv;
8094 }
8095
8096 /*
8097 =for apidoc sv_setref_pvn
8098
8099 Copies a string into a new SV, optionally blessing the SV.  The length of the
8100 string must be specified with C<n>.  The C<rv> argument will be upgraded to
8101 an RV.  That RV will be modified to point to the new SV.  The C<classname>
8102 argument indicates the package for the blessing.  Set C<classname> to
8103 C<Nullch> to avoid the blessing.  The new SV will have a reference count
8104 of 1, and the RV will be returned.
8105
8106 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8107
8108 =cut
8109 */
8110
8111 SV*
8112 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8113 {
8114     sv_setpvn(newSVrv(rv,classname), pv, n);
8115     return rv;
8116 }
8117
8118 /*
8119 =for apidoc sv_bless
8120
8121 Blesses an SV into a specified package.  The SV must be an RV.  The package
8122 must be designated by its stash (see C<gv_stashpv()>).  The reference count
8123 of the SV is unaffected.
8124
8125 =cut
8126 */
8127
8128 SV*
8129 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8130 {
8131     SV *tmpRef;
8132     if (!SvROK(sv))
8133         Perl_croak(aTHX_ "Can't bless non-reference value");
8134     tmpRef = SvRV(sv);
8135     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8136         if (SvREADONLY(tmpRef))
8137             Perl_croak(aTHX_ PL_no_modify);
8138         if (SvOBJECT(tmpRef)) {
8139             if (SvTYPE(tmpRef) != SVt_PVIO)
8140                 --PL_sv_objcount;
8141             SvREFCNT_dec(SvSTASH(tmpRef));
8142         }
8143     }
8144     SvOBJECT_on(tmpRef);
8145     if (SvTYPE(tmpRef) != SVt_PVIO)
8146         ++PL_sv_objcount;
8147     (void)SvUPGRADE(tmpRef, SVt_PVMG);
8148     SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8149
8150     if (Gv_AMG(stash))
8151         SvAMAGIC_on(sv);
8152     else
8153         SvAMAGIC_off(sv);
8154
8155     if(SvSMAGICAL(tmpRef))
8156         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8157             mg_set(tmpRef);
8158
8159
8160
8161     return sv;
8162 }
8163
8164 /* Downgrades a PVGV to a PVMG.
8165  */
8166
8167 STATIC void
8168 S_sv_unglob(pTHX_ SV *sv)
8169 {
8170     void *xpvmg;
8171
8172     assert(SvTYPE(sv) == SVt_PVGV);
8173     SvFAKE_off(sv);
8174     if (GvGP(sv))
8175         gp_free((GV*)sv);
8176     if (GvSTASH(sv)) {
8177         SvREFCNT_dec(GvSTASH(sv));
8178         GvSTASH(sv) = Nullhv;
8179     }
8180     sv_unmagic(sv, PERL_MAGIC_glob);
8181     Safefree(GvNAME(sv));
8182     GvMULTI_off(sv);
8183
8184     /* need to keep SvANY(sv) in the right arena */
8185     xpvmg = new_XPVMG();
8186     StructCopy(SvANY(sv), xpvmg, XPVMG);
8187     del_XPVGV(SvANY(sv));
8188     SvANY(sv) = xpvmg;
8189
8190     SvFLAGS(sv) &= ~SVTYPEMASK;
8191     SvFLAGS(sv) |= SVt_PVMG;
8192 }
8193
8194 /*
8195 =for apidoc sv_unref_flags
8196
8197 Unsets the RV status of the SV, and decrements the reference count of
8198 whatever was being referenced by the RV.  This can almost be thought of
8199 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
8200 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8201 (otherwise the decrementing is conditional on the reference count being
8202 different from one or the reference being a readonly SV).
8203 See C<SvROK_off>.
8204
8205 =cut
8206 */
8207
8208 void
8209 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8210 {
8211     SV* rv = SvRV(sv);
8212
8213     if (SvWEAKREF(sv)) {
8214         sv_del_backref(sv);
8215         SvWEAKREF_off(sv);
8216         SvRV(sv) = 0;
8217         return;
8218     }
8219     SvRV(sv) = 0;
8220     SvROK_off(sv);
8221     /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8222        assigned to as BEGIN {$a = \"Foo"} will fail.  */
8223     if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8224         SvREFCNT_dec(rv);
8225     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8226         sv_2mortal(rv);         /* Schedule for freeing later */
8227 }
8228
8229 /*
8230 =for apidoc sv_unref
8231
8232 Unsets the RV status of the SV, and decrements the reference count of
8233 whatever was being referenced by the RV.  This can almost be thought of
8234 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
8235 being zero.  See C<SvROK_off>.
8236
8237 =cut
8238 */
8239
8240 void
8241 Perl_sv_unref(pTHX_ SV *sv)
8242 {
8243     sv_unref_flags(sv, 0);
8244 }
8245
8246 /*
8247 =for apidoc sv_taint
8248
8249 Taint an SV. Use C<SvTAINTED_on> instead.
8250 =cut
8251 */
8252
8253 void
8254 Perl_sv_taint(pTHX_ SV *sv)
8255 {
8256     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8257 }
8258
8259 /*
8260 =for apidoc sv_untaint
8261
8262 Untaint an SV. Use C<SvTAINTED_off> instead.
8263 =cut
8264 */
8265
8266 void
8267 Perl_sv_untaint(pTHX_ SV *sv)
8268 {
8269     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8270         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8271         if (mg)
8272             mg->mg_len &= ~1;
8273     }
8274 }
8275
8276 /*
8277 =for apidoc sv_tainted
8278
8279 Test an SV for taintedness. Use C<SvTAINTED> instead.
8280 =cut
8281 */
8282
8283 bool
8284 Perl_sv_tainted(pTHX_ SV *sv)
8285 {
8286     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8287         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8288         if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8289             return TRUE;
8290     }
8291     return FALSE;
8292 }
8293
8294 /*
8295 =for apidoc sv_setpviv
8296
8297 Copies an integer into the given SV, also updating its string value.
8298 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
8299
8300 =cut
8301 */
8302
8303 void
8304 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8305 {
8306     char buf[TYPE_CHARS(UV)];
8307     char *ebuf;
8308     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8309
8310     sv_setpvn(sv, ptr, ebuf - ptr);
8311 }
8312
8313 /*
8314 =for apidoc sv_setpviv_mg
8315
8316 Like C<sv_setpviv>, but also handles 'set' magic.
8317
8318 =cut
8319 */
8320
8321 void
8322 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8323 {
8324     char buf[TYPE_CHARS(UV)];
8325     char *ebuf;
8326     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8327
8328     sv_setpvn(sv, ptr, ebuf - ptr);
8329     SvSETMAGIC(sv);
8330 }
8331
8332 #if defined(PERL_IMPLICIT_CONTEXT)
8333
8334 /* pTHX_ magic can't cope with varargs, so this is a no-context
8335  * version of the main function, (which may itself be aliased to us).
8336  * Don't access this version directly.
8337  */
8338
8339 void
8340 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8341 {
8342     dTHX;
8343     va_list args;
8344     va_start(args, pat);
8345     sv_vsetpvf(sv, pat, &args);
8346     va_end(args);
8347 }
8348
8349 /* pTHX_ magic can't cope with varargs, so this is a no-context
8350  * version of the main function, (which may itself be aliased to us).
8351  * Don't access this version directly.
8352  */
8353
8354 void
8355 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8356 {
8357     dTHX;
8358     va_list args;
8359     va_start(args, pat);
8360     sv_vsetpvf_mg(sv, pat, &args);
8361     va_end(args);
8362 }
8363 #endif
8364
8365 /*
8366 =for apidoc sv_setpvf
8367
8368 Processes its arguments like C<sprintf> and sets an SV to the formatted
8369 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
8370
8371 =cut
8372 */
8373
8374 void
8375 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8376 {
8377     va_list args;
8378     va_start(args, pat);
8379     sv_vsetpvf(sv, pat, &args);
8380     va_end(args);
8381 }
8382
8383 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8384
8385 void
8386 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8387 {
8388     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8389 }
8390
8391 /*
8392 =for apidoc sv_setpvf_mg
8393
8394 Like C<sv_setpvf>, but also handles 'set' magic.
8395
8396 =cut
8397 */
8398
8399 void
8400 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8401 {
8402     va_list args;
8403     va_start(args, pat);
8404     sv_vsetpvf_mg(sv, pat, &args);
8405     va_end(args);
8406 }
8407
8408 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8409
8410 void
8411 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8412 {
8413     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8414     SvSETMAGIC(sv);
8415 }
8416
8417 #if defined(PERL_IMPLICIT_CONTEXT)
8418
8419 /* pTHX_ magic can't cope with varargs, so this is a no-context
8420  * version of the main function, (which may itself be aliased to us).
8421  * Don't access this version directly.
8422  */
8423
8424 void
8425 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8426 {
8427     dTHX;
8428     va_list args;
8429     va_start(args, pat);
8430     sv_vcatpvf(sv, pat, &args);
8431     va_end(args);
8432 }
8433
8434 /* pTHX_ magic can't cope with varargs, so this is a no-context
8435  * version of the main function, (which may itself be aliased to us).
8436  * Don't access this version directly.
8437  */
8438
8439 void
8440 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8441 {
8442     dTHX;
8443     va_list args;
8444     va_start(args, pat);
8445     sv_vcatpvf_mg(sv, pat, &args);
8446     va_end(args);
8447 }
8448 #endif
8449
8450 /*
8451 =for apidoc sv_catpvf
8452
8453 Processes its arguments like C<sprintf> and appends the formatted
8454 output to an SV.  If the appended data contains "wide" characters
8455 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8456 and characters >255 formatted with %c), the original SV might get
8457 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
8458 C<SvSETMAGIC()> must typically be called after calling this function
8459 to handle 'set' magic.
8460
8461 =cut */
8462
8463 void
8464 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8465 {
8466     va_list args;
8467     va_start(args, pat);
8468     sv_vcatpvf(sv, pat, &args);
8469     va_end(args);
8470 }
8471
8472 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8473
8474 void
8475 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8476 {
8477     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8478 }
8479
8480 /*
8481 =for apidoc sv_catpvf_mg
8482
8483 Like C<sv_catpvf>, but also handles 'set' magic.
8484
8485 =cut
8486 */
8487
8488 void
8489 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8490 {
8491     va_list args;
8492     va_start(args, pat);
8493     sv_vcatpvf_mg(sv, pat, &args);
8494     va_end(args);
8495 }
8496
8497 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8498
8499 void
8500 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8501 {
8502     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8503     SvSETMAGIC(sv);
8504 }
8505
8506 /*
8507 =for apidoc sv_vsetpvfn
8508
8509 Works like C<vcatpvfn> but copies the text into the SV instead of
8510 appending it.
8511
8512 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8513
8514 =cut
8515 */
8516
8517 void
8518 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8519 {
8520     sv_setpvn(sv, "", 0);
8521     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8522 }
8523
8524 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8525
8526 STATIC I32
8527 S_expect_number(pTHX_ char** pattern)
8528 {
8529     I32 var = 0;
8530     switch (**pattern) {
8531     case '1': case '2': case '3':
8532     case '4': case '5': case '6':
8533     case '7': case '8': case '9':
8534         while (isDIGIT(**pattern))
8535             var = var * 10 + (*(*pattern)++ - '0');
8536     }
8537     return var;
8538 }
8539 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8540
8541 static char *
8542 F0convert(NV nv, char *endbuf, STRLEN *len)
8543 {
8544     int neg = nv < 0;
8545     UV uv;
8546     char *p = endbuf;
8547
8548     if (neg)
8549         nv = -nv;
8550     if (nv < UV_MAX) {
8551         nv += 0.5;
8552         uv = nv;
8553         if (uv & 1 && uv == nv)
8554             uv--;                       /* Round to even */
8555         do {
8556             unsigned dig = uv % 10;
8557             *--p = '0' + dig;
8558         } while (uv /= 10);
8559         if (neg)
8560             *--p = '-';
8561         *len = endbuf - p;
8562         return p;
8563     }
8564     return Nullch;
8565 }
8566
8567
8568 /*
8569 =for apidoc sv_vcatpvfn
8570
8571 Processes its arguments like C<vsprintf> and appends the formatted output
8572 to an SV.  Uses an array of SVs if the C style variable argument list is
8573 missing (NULL).  When running with taint checks enabled, indicates via
8574 C<maybe_tainted> if results are untrustworthy (often due to the use of
8575 locales).
8576
8577 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8578
8579 =cut
8580 */
8581
8582 void
8583 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8584 {
8585     char *p;
8586     char *q;
8587     char *patend;
8588     STRLEN origlen;
8589     I32 svix = 0;
8590     static char nullstr[] = "(null)";
8591     SV *argsv = Nullsv;
8592     bool has_utf8; /* has the result utf8? */
8593     bool pat_utf8; /* the pattern is in utf8? */
8594     SV *nsv = Nullsv;
8595     /* Times 4: a decimal digit takes more than 3 binary digits.
8596      * NV_DIG: mantissa takes than many decimal digits.
8597      * Plus 32: Playing safe. */
8598     char ebuf[IV_DIG * 4 + NV_DIG + 32];
8599     /* large enough for "%#.#f" --chip */
8600     /* what about long double NVs? --jhi */
8601
8602     has_utf8 = pat_utf8 = DO_UTF8(sv);
8603
8604     /* no matter what, this is a string now */
8605     (void)SvPV_force(sv, origlen);
8606
8607     /* special-case "", "%s", and "%_" */
8608     if (patlen == 0)
8609         return;
8610     if (patlen == 2 && pat[0] == '%') {
8611         switch (pat[1]) {
8612         case 's':
8613             if (args) {
8614                 char *s = va_arg(*args, char*);
8615                 sv_catpv(sv, s ? s : nullstr);
8616             }
8617             else if (svix < svmax) {
8618                 sv_catsv(sv, *svargs);
8619                 if (DO_UTF8(*svargs))
8620                     SvUTF8_on(sv);
8621             }
8622             return;
8623         case '_':
8624             if (args) {
8625                 argsv = va_arg(*args, SV*);
8626                 sv_catsv(sv, argsv);
8627                 if (DO_UTF8(argsv))
8628                     SvUTF8_on(sv);
8629                 return;
8630             }
8631             /* See comment on '_' below */
8632             break;
8633         }
8634     }
8635
8636 #ifndef USE_LONG_DOUBLE
8637     /* special-case "%.<number>[gf]" */
8638     if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8639          && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8640         unsigned digits = 0;
8641         const char *pp;
8642
8643         pp = pat + 2;
8644         while (*pp >= '0' && *pp <= '9')
8645             digits = 10 * digits + (*pp++ - '0');
8646         if (pp - pat == patlen - 1) {
8647             NV nv;
8648
8649             if (args)
8650                 nv = (NV)va_arg(*args, double);
8651             else if (svix < svmax)
8652                 nv = SvNV(*svargs);
8653             else
8654                 return;
8655             if (*pp == 'g') {
8656                 if (digits < sizeof(ebuf) - NV_DIG - 10) { /* 0, point, slack */
8657                     Gconvert(nv, (int)digits, 0, ebuf);
8658                     sv_catpv(sv, ebuf);
8659                     if (*ebuf)  /* May return an empty string for digits==0 */
8660                         return;
8661                 }
8662             } else if (!digits) {
8663                 STRLEN l;
8664
8665                 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8666                     sv_catpvn(sv, p, l);
8667                     return;
8668                 }
8669             }
8670         }
8671     }
8672 #endif /* !USE_LONG_DOUBLE */
8673
8674     if (!args && svix < svmax && DO_UTF8(*svargs))
8675         has_utf8 = TRUE;
8676
8677     patend = (char*)pat + patlen;
8678     for (p = (char*)pat; p < patend; p = q) {
8679         bool alt = FALSE;
8680         bool left = FALSE;
8681         bool vectorize = FALSE;
8682         bool vectorarg = FALSE;
8683         bool vec_utf8 = FALSE;
8684         char fill = ' ';
8685         char plus = 0;
8686         char intsize = 0;
8687         STRLEN width = 0;
8688         STRLEN zeros = 0;
8689         bool has_precis = FALSE;
8690         STRLEN precis = 0;
8691         I32 osvix = svix;
8692         bool is_utf8 = FALSE;  /* is this item utf8?   */
8693 #ifdef HAS_LDBL_SPRINTF_BUG
8694         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8695            with sfio - Allen <allens@cpan.org> */
8696         bool fix_ldbl_sprintf_bug = FALSE;
8697 #endif
8698
8699         char esignbuf[4];
8700         U8 utf8buf[UTF8_MAXLEN+1];
8701         STRLEN esignlen = 0;
8702
8703         char *eptr = Nullch;
8704         STRLEN elen = 0;
8705         SV *vecsv = Nullsv;
8706         U8 *vecstr = Null(U8*);
8707         STRLEN veclen = 0;
8708         char c = 0;
8709         int i;
8710         unsigned base = 0;
8711         IV iv = 0;
8712         UV uv = 0;
8713         /* we need a long double target in case HAS_LONG_DOUBLE but
8714            not USE_LONG_DOUBLE
8715         */
8716 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8717         long double nv;
8718 #else
8719         NV nv;
8720 #endif
8721         STRLEN have;
8722         STRLEN need;
8723         STRLEN gap;
8724         char *dotstr = ".";
8725         STRLEN dotstrlen = 1;
8726         I32 efix = 0; /* explicit format parameter index */
8727         I32 ewix = 0; /* explicit width index */
8728         I32 epix = 0; /* explicit precision index */
8729         I32 evix = 0; /* explicit vector index */
8730         bool asterisk = FALSE;
8731
8732         /* echo everything up to the next format specification */
8733         for (q = p; q < patend && *q != '%'; ++q) ;
8734         if (q > p) {
8735             if (has_utf8 && !pat_utf8)
8736                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8737             else
8738                 sv_catpvn(sv, p, q - p);
8739             p = q;
8740         }
8741         if (q++ >= patend)
8742             break;
8743
8744 /*
8745     We allow format specification elements in this order:
8746         \d+\$              explicit format parameter index
8747         [-+ 0#]+           flags
8748         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
8749         0                  flag (as above): repeated to allow "v02"
8750         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
8751         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8752         [hlqLV]            size
8753     [%bcdefginopsux_DFOUX] format (mandatory)
8754 */
8755         if (EXPECT_NUMBER(q, width)) {
8756             if (*q == '$') {
8757                 ++q;
8758                 efix = width;
8759             } else {
8760                 goto gotwidth;
8761             }
8762         }
8763
8764         /* FLAGS */
8765
8766         while (*q) {
8767             switch (*q) {
8768             case ' ':
8769             case '+':
8770                 plus = *q++;
8771                 continue;
8772
8773             case '-':
8774                 left = TRUE;
8775                 q++;
8776                 continue;
8777
8778             case '0':
8779                 fill = *q++;
8780                 continue;
8781
8782             case '#':
8783                 alt = TRUE;
8784                 q++;
8785                 continue;
8786
8787             default:
8788                 break;
8789             }
8790             break;
8791         }
8792
8793       tryasterisk:
8794         if (*q == '*') {
8795             q++;
8796             if (EXPECT_NUMBER(q, ewix))
8797                 if (*q++ != '$')
8798                     goto unknown;
8799             asterisk = TRUE;
8800         }
8801         if (*q == 'v') {
8802             q++;
8803             if (vectorize)
8804                 goto unknown;
8805             if ((vectorarg = asterisk)) {
8806                 evix = ewix;
8807                 ewix = 0;
8808                 asterisk = FALSE;
8809             }
8810             vectorize = TRUE;
8811             goto tryasterisk;
8812         }
8813
8814         if (!asterisk)
8815             if( *q == '0' )
8816                 fill = *q++;
8817             EXPECT_NUMBER(q, width);
8818
8819         if (vectorize) {
8820             if (vectorarg) {
8821                 if (args)
8822                     vecsv = va_arg(*args, SV*);
8823                 else
8824                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
8825                         svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8826                 dotstr = SvPVx(vecsv, dotstrlen);
8827                 if (DO_UTF8(vecsv))
8828                     is_utf8 = TRUE;
8829             }
8830             if (args) {
8831                 vecsv = va_arg(*args, SV*);
8832                 vecstr = (U8*)SvPVx(vecsv,veclen);
8833                 vec_utf8 = DO_UTF8(vecsv);
8834             }
8835             else if (efix ? efix <= svmax : svix < svmax) {
8836                 vecsv = svargs[efix ? efix-1 : svix++];
8837                 vecstr = (U8*)SvPVx(vecsv,veclen);
8838                 vec_utf8 = DO_UTF8(vecsv);
8839             }
8840             else {
8841                 vecstr = (U8*)"";
8842                 veclen = 0;
8843             }
8844         }
8845
8846         if (asterisk) {
8847             if (args)
8848                 i = va_arg(*args, int);
8849             else
8850                 i = (ewix ? ewix <= svmax : svix < svmax) ?
8851                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8852             left |= (i < 0);
8853             width = (i < 0) ? -i : i;
8854         }
8855       gotwidth:
8856
8857         /* PRECISION */
8858
8859         if (*q == '.') {
8860             q++;
8861             if (*q == '*') {
8862                 q++;
8863                 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8864                     goto unknown;
8865                 /* XXX: todo, support specified precision parameter */
8866                 if (epix)
8867                     goto unknown;
8868                 if (args)
8869                     i = va_arg(*args, int);
8870                 else
8871                     i = (ewix ? ewix <= svmax : svix < svmax)
8872                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8873                 precis = (i < 0) ? 0 : i;
8874             }
8875             else {
8876                 precis = 0;
8877                 while (isDIGIT(*q))
8878                     precis = precis * 10 + (*q++ - '0');
8879             }
8880             has_precis = TRUE;
8881         }
8882
8883         /* SIZE */
8884
8885         switch (*q) {
8886 #ifdef WIN32
8887         case 'I':                       /* Ix, I32x, and I64x */
8888 #  ifdef WIN64
8889             if (q[1] == '6' && q[2] == '4') {
8890                 q += 3;
8891                 intsize = 'q';
8892                 break;
8893             }
8894 #  endif
8895             if (q[1] == '3' && q[2] == '2') {
8896                 q += 3;
8897                 break;
8898             }
8899 #  ifdef WIN64
8900             intsize = 'q';
8901 #  endif
8902             q++;
8903             break;
8904 #endif
8905 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8906         case 'L':                       /* Ld */
8907             /* FALL THROUGH */
8908 #ifdef HAS_QUAD
8909         case 'q':                       /* qd */
8910 #endif
8911             intsize = 'q';
8912             q++;
8913             break;
8914 #endif
8915         case 'l':
8916 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8917             if (*(q + 1) == 'l') {      /* lld, llf */
8918                 intsize = 'q';
8919                 q += 2;
8920                 break;
8921              }
8922 #endif
8923             /* FALL THROUGH */
8924         case 'h':
8925             /* FALL THROUGH */
8926         case 'V':
8927             intsize = *q++;
8928             break;
8929         }
8930
8931         /* CONVERSION */
8932
8933         if (*q == '%') {
8934             eptr = q++;
8935             elen = 1;
8936             goto string;
8937         }
8938
8939         if (vectorize)
8940             argsv = vecsv;
8941         else if (!args)
8942             argsv = (efix ? efix <= svmax : svix < svmax) ?
8943                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8944
8945         switch (c = *q++) {
8946
8947             /* STRINGS */
8948
8949         case 'c':
8950             uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8951             if ((uv > 255 ||
8952                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8953                 && !IN_BYTES) {
8954                 eptr = (char*)utf8buf;
8955                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8956                 is_utf8 = TRUE;
8957             }
8958             else {
8959                 c = (char)uv;
8960                 eptr = &c;
8961                 elen = 1;
8962             }
8963             goto string;
8964
8965         case 's':
8966             if (args && !vectorize) {
8967                 eptr = va_arg(*args, char*);
8968                 if (eptr)
8969 #ifdef MACOS_TRADITIONAL
8970                   /* On MacOS, %#s format is used for Pascal strings */
8971                   if (alt)
8972                     elen = *eptr++;
8973                   else
8974 #endif
8975                     elen = strlen(eptr);
8976                 else {
8977                     eptr = nullstr;
8978                     elen = sizeof nullstr - 1;
8979                 }
8980             }
8981             else {
8982                 eptr = SvPVx(argsv, elen);
8983                 if (DO_UTF8(argsv)) {
8984                     if (has_precis && precis < elen) {
8985                         I32 p = precis;
8986                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8987                         precis = p;
8988                     }
8989                     if (width) { /* fudge width (can't fudge elen) */
8990                         width += elen - sv_len_utf8(argsv);
8991                     }
8992                     is_utf8 = TRUE;
8993                 }
8994             }
8995             goto string;
8996
8997         case '_':
8998             /*
8999              * The "%_" hack might have to be changed someday,
9000              * if ISO or ANSI decide to use '_' for something.
9001              * So we keep it hidden from users' code.
9002              */
9003             if (!args || vectorize)
9004                 goto unknown;
9005             argsv = va_arg(*args, SV*);
9006             eptr = SvPVx(argsv, elen);
9007             if (DO_UTF8(argsv))
9008                 is_utf8 = TRUE;
9009
9010         string:
9011             vectorize = FALSE;
9012             if (has_precis && elen > precis)
9013                 elen = precis;
9014             break;
9015
9016             /* INTEGERS */
9017
9018         case 'p':
9019             if (alt || vectorize)
9020                 goto unknown;
9021             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9022             base = 16;
9023             goto integer;
9024
9025         case 'D':
9026 #ifdef IV_IS_QUAD
9027             intsize = 'q';
9028 #else
9029             intsize = 'l';
9030 #endif
9031             /* FALL THROUGH */
9032         case 'd':
9033         case 'i':
9034             if (vectorize) {
9035                 STRLEN ulen;
9036                 if (!veclen)
9037                     continue;
9038                 if (vec_utf8)
9039                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9040                                         UTF8_ALLOW_ANYUV);
9041                 else {
9042                     uv = *vecstr;
9043                     ulen = 1;
9044                 }
9045                 vecstr += ulen;
9046                 veclen -= ulen;
9047                 if (plus)
9048                      esignbuf[esignlen++] = plus;
9049             }
9050             else if (args) {
9051                 switch (intsize) {
9052                 case 'h':       iv = (short)va_arg(*args, int); break;
9053                 default:        iv = va_arg(*args, int); break;
9054                 case 'l':       iv = va_arg(*args, long); break;
9055                 case 'V':       iv = va_arg(*args, IV); break;
9056 #ifdef HAS_QUAD
9057                 case 'q':       iv = va_arg(*args, Quad_t); break;
9058 #endif
9059                 }
9060             }
9061             else {
9062                 iv = SvIVx(argsv);
9063                 switch (intsize) {
9064                 case 'h':       iv = (short)iv; break;
9065                 default:        break;
9066                 case 'l':       iv = (long)iv; break;
9067                 case 'V':       break;
9068 #ifdef HAS_QUAD
9069                 case 'q':       iv = (Quad_t)iv; break;
9070 #endif
9071                 }
9072             }
9073             if ( !vectorize )   /* we already set uv above */
9074             {
9075                 if (iv >= 0) {
9076                     uv = iv;
9077                     if (plus)
9078                         esignbuf[esignlen++] = plus;
9079                 }
9080                 else {
9081                     uv = -iv;
9082                     esignbuf[esignlen++] = '-';
9083                 }
9084             }
9085             base = 10;
9086             goto integer;
9087
9088         case 'U':
9089 #ifdef IV_IS_QUAD
9090             intsize = 'q';
9091 #else
9092             intsize = 'l';
9093 #endif
9094             /* FALL THROUGH */
9095         case 'u':
9096             base = 10;
9097             goto uns_integer;
9098
9099         case 'b':
9100             base = 2;
9101             goto uns_integer;
9102
9103         case 'O':
9104 #ifdef IV_IS_QUAD
9105             intsize = 'q';
9106 #else
9107             intsize = 'l';
9108 #endif
9109             /* FALL THROUGH */
9110         case 'o':
9111             base = 8;
9112             goto uns_integer;
9113
9114         case 'X':
9115         case 'x':
9116             base = 16;
9117
9118         uns_integer:
9119             if (vectorize) {
9120                 STRLEN ulen;
9121         vector:
9122                 if (!veclen)
9123                     continue;
9124                 if (vec_utf8)
9125                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9126                                         UTF8_ALLOW_ANYUV);
9127                 else {
9128                     uv = *vecstr;
9129                     ulen = 1;
9130                 }
9131                 vecstr += ulen;
9132                 veclen -= ulen;
9133             }
9134             else if (args) {
9135                 switch (intsize) {
9136                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
9137                 default:   uv = va_arg(*args, unsigned); break;
9138                 case 'l':  uv = va_arg(*args, unsigned long); break;
9139                 case 'V':  uv = va_arg(*args, UV); break;
9140 #ifdef HAS_QUAD
9141                 case 'q':  uv = va_arg(*args, Quad_t); break;
9142 #endif
9143                 }
9144             }
9145             else {
9146                 uv = SvUVx(argsv);
9147                 switch (intsize) {
9148                 case 'h':       uv = (unsigned short)uv; break;
9149                 default:        break;
9150                 case 'l':       uv = (unsigned long)uv; break;
9151                 case 'V':       break;
9152 #ifdef HAS_QUAD
9153                 case 'q':       uv = (Quad_t)uv; break;
9154 #endif
9155                 }
9156             }
9157
9158         integer:
9159             eptr = ebuf + sizeof ebuf;
9160             switch (base) {
9161                 unsigned dig;
9162             case 16:
9163                 if (!uv)
9164                     alt = FALSE;
9165                 p = (char*)((c == 'X')
9166                             ? "0123456789ABCDEF" : "0123456789abcdef");
9167                 do {
9168                     dig = uv & 15;
9169                     *--eptr = p[dig];
9170                 } while (uv >>= 4);
9171                 if (alt) {
9172                     esignbuf[esignlen++] = '0';
9173                     esignbuf[esignlen++] = c;  /* 'x' or 'X' */
9174                 }
9175                 break;
9176             case 8:
9177                 do {
9178                     dig = uv & 7;
9179                     *--eptr = '0' + dig;
9180                 } while (uv >>= 3);
9181                 if (alt && *eptr != '0')
9182                     *--eptr = '0';
9183                 break;
9184             case 2:
9185                 do {
9186                     dig = uv & 1;
9187                     *--eptr = '0' + dig;
9188                 } while (uv >>= 1);
9189                 if (alt) {
9190                     esignbuf[esignlen++] = '0';
9191                     esignbuf[esignlen++] = 'b';
9192                 }
9193                 break;
9194             default:            /* it had better be ten or less */
9195 #if defined(PERL_Y2KWARN)
9196                 if (ckWARN(WARN_Y2K)) {
9197                     STRLEN n;
9198                     char *s = SvPV(sv,n);
9199                     if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9200                         && (n == 2 || !isDIGIT(s[n-3])))
9201                     {
9202                         Perl_warner(aTHX_ packWARN(WARN_Y2K),
9203                                     "Possible Y2K bug: %%%c %s",
9204                                     c, "format string following '19'");
9205                     }
9206                 }
9207 #endif
9208                 do {
9209                     dig = uv % base;
9210                     *--eptr = '0' + dig;
9211                 } while (uv /= base);
9212                 break;
9213             }
9214             elen = (ebuf + sizeof ebuf) - eptr;
9215             if (has_precis) {
9216                 if (precis > elen)
9217                     zeros = precis - elen;
9218                 else if (precis == 0 && elen == 1 && *eptr == '0')
9219                     elen = 0;
9220             }
9221             break;
9222
9223             /* FLOATING POINT */
9224
9225         case 'F':
9226             c = 'f';            /* maybe %F isn't supported here */
9227             /* FALL THROUGH */
9228         case 'e': case 'E':
9229         case 'f':
9230         case 'g': case 'G':
9231
9232             /* This is evil, but floating point is even more evil */
9233
9234             /* for SV-style calling, we can only get NV
9235                for C-style calling, we assume %f is double;
9236                for simplicity we allow any of %Lf, %llf, %qf for long double
9237             */
9238             switch (intsize) {
9239             case 'V':
9240 #if defined(USE_LONG_DOUBLE)
9241                 intsize = 'q';
9242 #endif
9243                 break;
9244 /* [perl #20339] - we should accept and ignore %lf rather than die */
9245             case 'l':
9246                 /* FALL THROUGH */
9247             default:
9248 #if defined(USE_LONG_DOUBLE)
9249                 intsize = args ? 0 : 'q';
9250 #endif
9251                 break;
9252             case 'q':
9253 #if defined(HAS_LONG_DOUBLE)
9254                 break;
9255 #else
9256                 /* FALL THROUGH */
9257 #endif
9258             case 'h':
9259                 goto unknown;
9260             }
9261
9262             /* now we need (long double) if intsize == 'q', else (double) */
9263             nv = (args && !vectorize) ?
9264 #if LONG_DOUBLESIZE > DOUBLESIZE
9265                 intsize == 'q' ?
9266                     va_arg(*args, long double) :
9267                     va_arg(*args, double)
9268 #else
9269                     va_arg(*args, double)
9270 #endif
9271                 : SvNVx(argsv);
9272
9273             need = 0;
9274             vectorize = FALSE;
9275             if (c != 'e' && c != 'E') {
9276                 i = PERL_INT_MIN;
9277                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9278                    will cast our (long double) to (double) */
9279                 (void)Perl_frexp(nv, &i);
9280                 if (i == PERL_INT_MIN)
9281                     Perl_die(aTHX_ "panic: frexp");
9282                 if (i > 0)
9283                     need = BIT_DIGITS(i);
9284             }
9285             need += has_precis ? precis : 6; /* known default */
9286
9287             if (need < width)
9288                 need = width;
9289
9290 #ifdef HAS_LDBL_SPRINTF_BUG
9291             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9292                with sfio - Allen <allens@cpan.org> */
9293
9294 #  ifdef DBL_MAX
9295 #    define MY_DBL_MAX DBL_MAX
9296 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9297 #    if DOUBLESIZE >= 8
9298 #      define MY_DBL_MAX 1.7976931348623157E+308L
9299 #    else
9300 #      define MY_DBL_MAX 3.40282347E+38L
9301 #    endif
9302 #  endif
9303
9304 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9305 #    define MY_DBL_MAX_BUG 1L
9306 #  else
9307 #    define MY_DBL_MAX_BUG MY_DBL_MAX
9308 #  endif
9309
9310 #  ifdef DBL_MIN
9311 #    define MY_DBL_MIN DBL_MIN
9312 #  else  /* XXX guessing! -Allen */
9313 #    if DOUBLESIZE >= 8
9314 #      define MY_DBL_MIN 2.2250738585072014E-308L
9315 #    else
9316 #      define MY_DBL_MIN 1.17549435E-38L
9317 #    endif
9318 #  endif
9319
9320             if ((intsize == 'q') && (c == 'f') &&
9321                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9322                 (need < DBL_DIG)) {
9323                 /* it's going to be short enough that
9324                  * long double precision is not needed */
9325
9326                 if ((nv <= 0L) && (nv >= -0L))
9327                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9328                 else {
9329                     /* would use Perl_fp_class as a double-check but not
9330                      * functional on IRIX - see perl.h comments */
9331
9332                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9333                         /* It's within the range that a double can represent */
9334 #if defined(DBL_MAX) && !defined(DBL_MIN)
9335                         if ((nv >= ((long double)1/DBL_MAX)) ||
9336                             (nv <= (-(long double)1/DBL_MAX)))
9337 #endif
9338                         fix_ldbl_sprintf_bug = TRUE;
9339                     }
9340                 }
9341                 if (fix_ldbl_sprintf_bug == TRUE) {
9342                     double temp;
9343
9344                     intsize = 0;
9345                     temp = (double)nv;
9346                     nv = (NV)temp;
9347                 }
9348             }
9349
9350 #  undef MY_DBL_MAX
9351 #  undef MY_DBL_MAX_BUG
9352 #  undef MY_DBL_MIN
9353
9354 #endif /* HAS_LDBL_SPRINTF_BUG */
9355
9356             need += 20; /* fudge factor */
9357             if (PL_efloatsize < need) {
9358                 Safefree(PL_efloatbuf);
9359                 PL_efloatsize = need + 20; /* more fudge */
9360                 New(906, PL_efloatbuf, PL_efloatsize, char);
9361                 PL_efloatbuf[0] = '\0';
9362             }
9363
9364             if ( !(width || left || plus || alt) && fill != '0'
9365                  && has_precis && intsize != 'q' ) {    /* Shortcuts */
9366                 if ( c == 'g') {
9367                     Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9368                     if (*PL_efloatbuf)  /* May return an empty string for digits==0 */
9369                         goto float_converted;
9370                 } else if ( c == 'f' && !precis) {
9371                     if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9372                         break;
9373                 }
9374             }
9375             eptr = ebuf + sizeof ebuf;
9376             *--eptr = '\0';
9377             *--eptr = c;
9378             /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9379 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9380             if (intsize == 'q') {
9381                 /* Copy the one or more characters in a long double
9382                  * format before the 'base' ([efgEFG]) character to
9383                  * the format string. */
9384                 static char const prifldbl[] = PERL_PRIfldbl;
9385                 char const *p = prifldbl + sizeof(prifldbl) - 3;
9386                 while (p >= prifldbl) { *--eptr = *p--; }
9387             }
9388 #endif
9389             if (has_precis) {
9390                 base = precis;
9391                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9392                 *--eptr = '.';
9393             }
9394             if (width) {
9395                 base = width;
9396                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9397             }
9398             if (fill == '0')
9399                 *--eptr = fill;
9400             if (left)
9401                 *--eptr = '-';
9402             if (plus)
9403                 *--eptr = plus;
9404             if (alt)
9405                 *--eptr = '#';
9406             *--eptr = '%';
9407
9408             /* No taint.  Otherwise we are in the strange situation
9409              * where printf() taints but print($float) doesn't.
9410              * --jhi */
9411 #if defined(HAS_LONG_DOUBLE)
9412             if (intsize == 'q')
9413                 (void)sprintf(PL_efloatbuf, eptr, nv);
9414             else
9415                 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9416 #else
9417             (void)sprintf(PL_efloatbuf, eptr, nv);
9418 #endif
9419         float_converted:
9420             eptr = PL_efloatbuf;
9421             elen = strlen(PL_efloatbuf);
9422             break;
9423
9424             /* SPECIAL */
9425
9426         case 'n':
9427             i = SvCUR(sv) - origlen;
9428             if (args && !vectorize) {
9429                 switch (intsize) {
9430                 case 'h':       *(va_arg(*args, short*)) = i; break;
9431                 default:        *(va_arg(*args, int*)) = i; break;
9432                 case 'l':       *(va_arg(*args, long*)) = i; break;
9433                 case 'V':       *(va_arg(*args, IV*)) = i; break;
9434 #ifdef HAS_QUAD
9435                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
9436 #endif
9437                 }
9438             }
9439             else
9440                 sv_setuv_mg(argsv, (UV)i);
9441             vectorize = FALSE;
9442             continue;   /* not "break" */
9443
9444             /* UNKNOWN */
9445
9446         default:
9447       unknown:
9448             if (!args && ckWARN(WARN_PRINTF) &&
9449                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9450                 SV *msg = sv_newmortal();
9451                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9452                           (PL_op->op_type == OP_PRTF) ? "" : "s");
9453                 if (c) {
9454                     if (isPRINT(c))
9455                         Perl_sv_catpvf(aTHX_ msg,
9456                                        "\"%%%c\"", c & 0xFF);
9457                     else
9458                         Perl_sv_catpvf(aTHX_ msg,
9459                                        "\"%%\\%03"UVof"\"",
9460                                        (UV)c & 0xFF);
9461                 } else
9462                     sv_catpv(msg, "end of string");
9463                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9464             }
9465
9466             /* output mangled stuff ... */
9467             if (c == '\0')
9468                 --q;
9469             eptr = p;
9470             elen = q - p;
9471
9472             /* ... right here, because formatting flags should not apply */
9473             SvGROW(sv, SvCUR(sv) + elen + 1);
9474             p = SvEND(sv);
9475             Copy(eptr, p, elen, char);
9476             p += elen;
9477             *p = '\0';
9478             SvCUR(sv) = p - SvPVX(sv);
9479             svix = osvix;
9480             continue;   /* not "break" */
9481         }
9482
9483         if (is_utf8 != has_utf8) {
9484              if (is_utf8) {
9485                   if (SvCUR(sv))
9486                        sv_utf8_upgrade(sv);
9487              }
9488              else {
9489                   SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9490                   sv_utf8_upgrade(nsv);
9491                   eptr = SvPVX(nsv);
9492                   elen = SvCUR(nsv);
9493              }
9494              SvGROW(sv, SvCUR(sv) + elen + 1);
9495              p = SvEND(sv);
9496              *p = '\0';
9497         }
9498         /* Use memchr() instead of strchr(), as eptr is not guaranteed */
9499         /* to point to a null-terminated string.                       */
9500         if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
9501             (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
9502             Perl_warner(aTHX_ packWARN(WARN_PRINTF),
9503                 "Newline in left-justified string for %sprintf",
9504                         (PL_op->op_type == OP_PRTF) ? "" : "s");
9505
9506         have = esignlen + zeros + elen;
9507         need = (have > width ? have : width);
9508         gap = need - have;
9509
9510         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9511         p = SvEND(sv);
9512         if (esignlen && fill == '0') {
9513             for (i = 0; i < (int)esignlen; i++)
9514                 *p++ = esignbuf[i];
9515         }
9516         if (gap && !left) {
9517             memset(p, fill, gap);
9518             p += gap;
9519         }
9520         if (esignlen && fill != '0') {
9521             for (i = 0; i < (int)esignlen; i++)
9522                 *p++ = esignbuf[i];
9523         }
9524         if (zeros) {
9525             for (i = zeros; i; i--)
9526                 *p++ = '0';
9527         }
9528         if (elen) {
9529             Copy(eptr, p, elen, char);
9530             p += elen;
9531         }
9532         if (gap && left) {
9533             memset(p, ' ', gap);
9534             p += gap;
9535         }
9536         if (vectorize) {
9537             if (veclen) {
9538                 Copy(dotstr, p, dotstrlen, char);
9539                 p += dotstrlen;
9540             }
9541             else
9542                 vectorize = FALSE;              /* done iterating over vecstr */
9543         }
9544         if (is_utf8)
9545             has_utf8 = TRUE;
9546         if (has_utf8)
9547             SvUTF8_on(sv);
9548         *p = '\0';
9549         SvCUR(sv) = p - SvPVX(sv);
9550         if (vectorize) {
9551             esignlen = 0;
9552             goto vector;
9553         }
9554     }
9555 }
9556
9557 /* =========================================================================
9558
9559 =head1 Cloning an interpreter
9560
9561 All the macros and functions in this section are for the private use of
9562 the main function, perl_clone().
9563
9564 The foo_dup() functions make an exact copy of an existing foo thinngy.
9565 During the course of a cloning, a hash table is used to map old addresses
9566 to new addresses. The table is created and manipulated with the
9567 ptr_table_* functions.
9568
9569 =cut
9570
9571 ============================================================================*/
9572
9573
9574 #if defined(USE_ITHREADS)
9575
9576 #ifndef GpREFCNT_inc
9577 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9578 #endif
9579
9580
9581 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9582 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
9583 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9584 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
9585 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9586 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
9587 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9588 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
9589 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9590 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
9591 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9592 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
9593 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
9594
9595
9596 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9597    regcomp.c. AMS 20010712 */
9598
9599 REGEXP *
9600 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9601 {
9602     REGEXP *ret;
9603     int i, len, npar;
9604     struct reg_substr_datum *s;
9605
9606     if (!r)
9607         return (REGEXP *)NULL;
9608
9609     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9610         return ret;
9611
9612     len = r->offsets[0];
9613     npar = r->nparens+1;
9614
9615     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9616     Copy(r->program, ret->program, len+1, regnode);
9617
9618     New(0, ret->startp, npar, I32);
9619     Copy(r->startp, ret->startp, npar, I32);
9620     New(0, ret->endp, npar, I32);
9621     Copy(r->startp, ret->startp, npar, I32);
9622
9623     New(0, ret->substrs, 1, struct reg_substr_data);
9624     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9625         s->min_offset = r->substrs->data[i].min_offset;
9626         s->max_offset = r->substrs->data[i].max_offset;
9627         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
9628         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9629     }
9630
9631     ret->regstclass = NULL;
9632     if (r->data) {
9633         struct reg_data *d;
9634         int count = r->data->count;
9635
9636         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9637                 char, struct reg_data);
9638         New(0, d->what, count, U8);
9639
9640         d->count = count;
9641         for (i = 0; i < count; i++) {
9642             d->what[i] = r->data->what[i];
9643             switch (d->what[i]) {
9644             case 's':
9645                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9646                 break;
9647             case 'p':
9648                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9649                 break;
9650             case 'f':
9651                 /* This is cheating. */
9652                 New(0, d->data[i], 1, struct regnode_charclass_class);
9653                 StructCopy(r->data->data[i], d->data[i],
9654                             struct regnode_charclass_class);
9655                 ret->regstclass = (regnode*)d->data[i];
9656                 break;
9657             case 'o':
9658                 /* Compiled op trees are readonly, and can thus be
9659                    shared without duplication. */
9660                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9661                 break;
9662             case 'n':
9663                 d->data[i] = r->data->data[i];
9664                 break;
9665             }
9666         }
9667
9668         ret->data = d;
9669     }
9670     else
9671         ret->data = NULL;
9672
9673     New(0, ret->offsets, 2*len+1, U32);
9674     Copy(r->offsets, ret->offsets, 2*len+1, U32);
9675
9676     ret->precomp        = SAVEPV(r->precomp);
9677     ret->refcnt         = r->refcnt;
9678     ret->minlen         = r->minlen;
9679     ret->prelen         = r->prelen;
9680     ret->nparens        = r->nparens;
9681     ret->lastparen      = r->lastparen;
9682     ret->lastcloseparen = r->lastcloseparen;
9683     ret->reganch        = r->reganch;
9684
9685     ret->sublen         = r->sublen;
9686
9687     if (RX_MATCH_COPIED(ret))
9688         ret->subbeg  = SAVEPV(r->subbeg);
9689     else
9690         ret->subbeg = Nullch;
9691 #ifdef PERL_COPY_ON_WRITE
9692     ret->saved_copy = Nullsv;
9693 #endif
9694
9695     ptr_table_store(PL_ptr_table, r, ret);
9696     return ret;
9697 }
9698
9699 /* duplicate a file handle */
9700
9701 PerlIO *
9702 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9703 {
9704     PerlIO *ret;
9705     if (!fp)
9706         return (PerlIO*)NULL;
9707
9708     /* look for it in the table first */
9709     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9710     if (ret)
9711         return ret;
9712
9713     /* create anew and remember what it is */
9714     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9715     ptr_table_store(PL_ptr_table, fp, ret);
9716     return ret;
9717 }
9718
9719 /* duplicate a directory handle */
9720
9721 DIR *
9722 Perl_dirp_dup(pTHX_ DIR *dp)
9723 {
9724     if (!dp)
9725         return (DIR*)NULL;
9726     /* XXX TODO */
9727     return dp;
9728 }
9729
9730 /* duplicate a typeglob */
9731
9732 GP *
9733 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9734 {
9735     GP *ret;
9736     if (!gp)
9737         return (GP*)NULL;
9738     /* look for it in the table first */
9739     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9740     if (ret)
9741         return ret;
9742
9743     /* create anew and remember what it is */
9744     Newz(0, ret, 1, GP);
9745     ptr_table_store(PL_ptr_table, gp, ret);
9746
9747     /* clone */
9748     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
9749     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
9750     ret->gp_io          = io_dup_inc(gp->gp_io, param);
9751     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
9752     ret->gp_av          = av_dup_inc(gp->gp_av, param);
9753     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
9754     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9755     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
9756     ret->gp_cvgen       = gp->gp_cvgen;
9757     ret->gp_flags       = gp->gp_flags;
9758     ret->gp_line        = gp->gp_line;
9759     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
9760     return ret;
9761 }
9762
9763 /* duplicate a chain of magic */
9764
9765 MAGIC *
9766 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9767 {
9768     MAGIC *mgprev = (MAGIC*)NULL;
9769     MAGIC *mgret;
9770     if (!mg)
9771         return (MAGIC*)NULL;
9772     /* look for it in the table first */
9773     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9774     if (mgret)
9775         return mgret;
9776
9777     for (; mg; mg = mg->mg_moremagic) {
9778         MAGIC *nmg;
9779         Newz(0, nmg, 1, MAGIC);
9780         if (mgprev)
9781             mgprev->mg_moremagic = nmg;
9782         else
9783             mgret = nmg;
9784         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
9785         nmg->mg_private = mg->mg_private;
9786         nmg->mg_type    = mg->mg_type;
9787         nmg->mg_flags   = mg->mg_flags;
9788         if (mg->mg_type == PERL_MAGIC_qr) {
9789             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9790         }
9791         else if(mg->mg_type == PERL_MAGIC_backref) {
9792              AV *av = (AV*) mg->mg_obj;
9793              SV **svp;
9794              I32 i;
9795              nmg->mg_obj = (SV*)newAV();
9796              svp = AvARRAY(av);
9797              i = AvFILLp(av);
9798              while (i >= 0) {
9799                   av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9800                   i--;
9801              }
9802         }
9803         else {
9804             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9805                               ? sv_dup_inc(mg->mg_obj, param)
9806                               : sv_dup(mg->mg_obj, param);
9807         }
9808         nmg->mg_len     = mg->mg_len;
9809         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
9810         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9811             if (mg->mg_len > 0) {
9812                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
9813                 if (mg->mg_type == PERL_MAGIC_overload_table &&
9814                         AMT_AMAGIC((AMT*)mg->mg_ptr))
9815                 {
9816                     AMT *amtp = (AMT*)mg->mg_ptr;
9817                     AMT *namtp = (AMT*)nmg->mg_ptr;
9818                     I32 i;
9819                     for (i = 1; i < NofAMmeth; i++) {
9820                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9821                     }
9822                 }
9823             }
9824             else if (mg->mg_len == HEf_SVKEY)
9825                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9826         }
9827         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9828             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9829         }
9830         mgprev = nmg;
9831     }
9832     return mgret;
9833 }
9834
9835 /* create a new pointer-mapping table */
9836
9837 PTR_TBL_t *
9838 Perl_ptr_table_new(pTHX)
9839 {
9840     PTR_TBL_t *tbl;
9841     Newz(0, tbl, 1, PTR_TBL_t);
9842     tbl->tbl_max        = 511;
9843     tbl->tbl_items      = 0;
9844     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9845     return tbl;
9846 }
9847
9848 /* map an existing pointer using a table */
9849
9850 void *
9851 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9852 {
9853     PTR_TBL_ENT_t *tblent;
9854     UV hash = PTR2UV(sv);
9855     assert(tbl);
9856     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9857     for (; tblent; tblent = tblent->next) {
9858         if (tblent->oldval == sv)
9859             return tblent->newval;
9860     }
9861     return (void*)NULL;
9862 }
9863
9864 /* add a new entry to a pointer-mapping table */
9865
9866 void
9867 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9868 {
9869     PTR_TBL_ENT_t *tblent, **otblent;
9870     /* XXX this may be pessimal on platforms where pointers aren't good
9871      * hash values e.g. if they grow faster in the most significant
9872      * bits */
9873     UV hash = PTR2UV(oldv);
9874     bool i = 1;
9875
9876     assert(tbl);
9877     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9878     for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9879         if (tblent->oldval == oldv) {
9880             tblent->newval = newv;
9881             return;
9882         }
9883     }
9884     Newz(0, tblent, 1, PTR_TBL_ENT_t);
9885     tblent->oldval = oldv;
9886     tblent->newval = newv;
9887     tblent->next = *otblent;
9888     *otblent = tblent;
9889     tbl->tbl_items++;
9890     if (i && tbl->tbl_items > tbl->tbl_max)
9891         ptr_table_split(tbl);
9892 }
9893
9894 /* double the hash bucket size of an existing ptr table */
9895
9896 void
9897 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9898 {
9899     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9900     UV oldsize = tbl->tbl_max + 1;
9901     UV newsize = oldsize * 2;
9902     UV i;
9903
9904     Renew(ary, newsize, PTR_TBL_ENT_t*);
9905     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9906     tbl->tbl_max = --newsize;
9907     tbl->tbl_ary = ary;
9908     for (i=0; i < oldsize; i++, ary++) {
9909         PTR_TBL_ENT_t **curentp, **entp, *ent;
9910         if (!*ary)
9911             continue;
9912         curentp = ary + oldsize;
9913         for (entp = ary, ent = *ary; ent; ent = *entp) {
9914             if ((newsize & PTR2UV(ent->oldval)) != i) {
9915                 *entp = ent->next;
9916                 ent->next = *curentp;
9917                 *curentp = ent;
9918                 continue;
9919             }
9920             else
9921                 entp = &ent->next;
9922         }
9923     }
9924 }
9925
9926 /* remove all the entries from a ptr table */
9927
9928 void
9929 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9930 {
9931     register PTR_TBL_ENT_t **array;
9932     register PTR_TBL_ENT_t *entry;
9933     register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9934     UV riter = 0;
9935     UV max;
9936
9937     if (!tbl || !tbl->tbl_items) {
9938         return;
9939     }
9940
9941     array = tbl->tbl_ary;
9942     entry = array[0];
9943     max = tbl->tbl_max;
9944
9945     for (;;) {
9946         if (entry) {
9947             oentry = entry;
9948             entry = entry->next;
9949             Safefree(oentry);
9950         }
9951         if (!entry) {
9952             if (++riter > max) {
9953                 break;
9954             }
9955             entry = array[riter];
9956         }
9957     }
9958
9959     tbl->tbl_items = 0;
9960 }
9961
9962 /* clear and free a ptr table */
9963
9964 void
9965 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9966 {
9967     if (!tbl) {
9968         return;
9969     }
9970     ptr_table_clear(tbl);
9971     Safefree(tbl->tbl_ary);
9972     Safefree(tbl);
9973 }
9974
9975 #ifdef DEBUGGING
9976 char *PL_watch_pvx;
9977 #endif
9978
9979 /* attempt to make everything in the typeglob readonly */
9980
9981 STATIC SV *
9982 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9983 {
9984     GV *gv = (GV*)sstr;
9985     SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9986
9987     if (GvIO(gv) || GvFORM(gv)) {
9988         GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9989     }
9990     else if (!GvCV(gv)) {
9991         GvCV(gv) = (CV*)sv;
9992     }
9993     else {
9994         /* CvPADLISTs cannot be shared */
9995         if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9996             GvUNIQUE_off(gv);
9997         }
9998     }
9999
10000     if (!GvUNIQUE(gv)) {
10001 #if 0
10002         PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10003                       HvNAME(GvSTASH(gv)), GvNAME(gv));
10004 #endif
10005         return Nullsv;
10006     }
10007
10008     /*
10009      * write attempts will die with
10010      * "Modification of a read-only value attempted"
10011      */
10012     if (!GvSV(gv)) {
10013         GvSV(gv) = sv;
10014     }
10015     else {
10016         SvREADONLY_on(GvSV(gv));
10017     }
10018
10019     if (!GvAV(gv)) {
10020         GvAV(gv) = (AV*)sv;
10021     }
10022     else {
10023         SvREADONLY_on(GvAV(gv));
10024     }
10025
10026     if (!GvHV(gv)) {
10027         GvHV(gv) = (HV*)sv;
10028     }
10029     else {
10030         SvREADONLY_on(GvAV(gv));
10031     }
10032
10033     return sstr; /* he_dup() will SvREFCNT_inc() */
10034 }
10035
10036 /* duplicate an SV of any type (including AV, HV etc) */
10037
10038 void
10039 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10040 {
10041     if (SvROK(sstr)) {
10042         SvRV(dstr) = SvWEAKREF(sstr)
10043                      ? sv_dup(SvRV(sstr), param)
10044                      : sv_dup_inc(SvRV(sstr), param);
10045     }
10046     else if (SvPVX(sstr)) {
10047         /* Has something there */
10048         if (SvLEN(sstr)) {
10049             /* Normal PV - clone whole allocated space */
10050             SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10051             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10052                 /* Not that normal - actually sstr is copy on write.
10053                    But we are a true, independant SV, so:  */
10054                 SvREADONLY_off(dstr);
10055                 SvFAKE_off(dstr);
10056             }
10057         }
10058         else {
10059             /* Special case - not normally malloced for some reason */
10060             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10061                 /* A "shared" PV - clone it as unshared string */
10062                 if(SvPADTMP(sstr)) {
10063                     /* However, some of them live in the pad
10064                        and they should not have these flags
10065                        turned off */
10066
10067                     SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10068                                            SvUVX(sstr));
10069                     SvUVX(dstr) = SvUVX(sstr);
10070                 } else {
10071
10072                     SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10073                     SvFAKE_off(dstr);
10074                     SvREADONLY_off(dstr);
10075                 }
10076             }
10077             else {
10078                 /* Some other special case - random pointer */
10079                 SvPVX(dstr) = SvPVX(sstr);
10080             }
10081         }
10082     }
10083     else {
10084         /* Copy the Null */
10085         SvPVX(dstr) = SvPVX(sstr);
10086     }
10087 }
10088
10089 SV *
10090 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10091 {
10092     SV *dstr;
10093
10094     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10095         return Nullsv;
10096     /* look for it in the table first */
10097     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10098     if (dstr)
10099         return dstr;
10100
10101     if(param->flags & CLONEf_JOIN_IN) {
10102         /** We are joining here so we don't want do clone
10103             something that is bad **/
10104
10105         if(SvTYPE(sstr) == SVt_PVHV &&
10106            HvNAME(sstr)) {
10107             /** don't clone stashes if they already exist **/
10108             HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10109             return (SV*) old_stash;
10110         }
10111     }
10112
10113     /* create anew and remember what it is */
10114     new_SV(dstr);
10115     ptr_table_store(PL_ptr_table, sstr, dstr);
10116
10117     /* clone */
10118     SvFLAGS(dstr)       = SvFLAGS(sstr);
10119     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
10120     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
10121
10122 #ifdef DEBUGGING
10123     if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10124         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10125                       PL_watch_pvx, SvPVX(sstr));
10126 #endif
10127
10128     switch (SvTYPE(sstr)) {
10129     case SVt_NULL:
10130         SvANY(dstr)     = NULL;
10131         break;
10132     case SVt_IV:
10133         SvANY(dstr)     = new_XIV();
10134         SvIVX(dstr)     = SvIVX(sstr);
10135         break;
10136     case SVt_NV:
10137         SvANY(dstr)     = new_XNV();
10138         SvNVX(dstr)     = SvNVX(sstr);
10139         break;
10140     case SVt_RV:
10141         SvANY(dstr)     = new_XRV();
10142         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10143         break;
10144     case SVt_PV:
10145         SvANY(dstr)     = new_XPV();
10146         SvCUR(dstr)     = SvCUR(sstr);
10147         SvLEN(dstr)     = SvLEN(sstr);
10148         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10149         break;
10150     case SVt_PVIV:
10151         SvANY(dstr)     = new_XPVIV();
10152         SvCUR(dstr)     = SvCUR(sstr);
10153         SvLEN(dstr)     = SvLEN(sstr);
10154         SvIVX(dstr)     = SvIVX(sstr);
10155         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10156         break;
10157     case SVt_PVNV:
10158         SvANY(dstr)     = new_XPVNV();
10159         SvCUR(dstr)     = SvCUR(sstr);
10160         SvLEN(dstr)     = SvLEN(sstr);
10161         SvIVX(dstr)     = SvIVX(sstr);
10162         SvNVX(dstr)     = SvNVX(sstr);
10163         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10164         break;
10165     case SVt_PVMG:
10166         SvANY(dstr)     = new_XPVMG();
10167         SvCUR(dstr)     = SvCUR(sstr);
10168         SvLEN(dstr)     = SvLEN(sstr);
10169         SvIVX(dstr)     = SvIVX(sstr);
10170         SvNVX(dstr)     = SvNVX(sstr);
10171         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10172         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10173         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10174         break;
10175     case SVt_PVBM:
10176         SvANY(dstr)     = new_XPVBM();
10177         SvCUR(dstr)     = SvCUR(sstr);
10178         SvLEN(dstr)     = SvLEN(sstr);
10179         SvIVX(dstr)     = SvIVX(sstr);
10180         SvNVX(dstr)     = SvNVX(sstr);
10181         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10182         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10183         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10184         BmRARE(dstr)    = BmRARE(sstr);
10185         BmUSEFUL(dstr)  = BmUSEFUL(sstr);
10186         BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10187         break;
10188     case SVt_PVLV:
10189         SvANY(dstr)     = new_XPVLV();
10190         SvCUR(dstr)     = SvCUR(sstr);
10191         SvLEN(dstr)     = SvLEN(sstr);
10192         SvIVX(dstr)     = SvIVX(sstr);
10193         SvNVX(dstr)     = SvNVX(sstr);
10194         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10195         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10196         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10197         LvTARGOFF(dstr) = LvTARGOFF(sstr);      /* XXX sometimes holds PMOP* when DEBUGGING */
10198         LvTARGLEN(dstr) = LvTARGLEN(sstr);
10199         if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10200             LvTARG(dstr) = dstr;
10201         else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10202             LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10203         else
10204             LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10205         LvTYPE(dstr)    = LvTYPE(sstr);
10206         break;
10207     case SVt_PVGV:
10208         if (GvUNIQUE((GV*)sstr)) {
10209             SV *share;
10210             if ((share = gv_share(sstr, param))) {
10211                 del_SV(dstr);
10212                 dstr = share;
10213                 ptr_table_store(PL_ptr_table, sstr, dstr);
10214 #if 0
10215                 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10216                               HvNAME(GvSTASH(share)), GvNAME(share));
10217 #endif
10218                 break;
10219             }
10220         }
10221         SvANY(dstr)     = new_XPVGV();
10222         SvCUR(dstr)     = SvCUR(sstr);
10223         SvLEN(dstr)     = SvLEN(sstr);
10224         SvIVX(dstr)     = SvIVX(sstr);
10225         SvNVX(dstr)     = SvNVX(sstr);
10226         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10227         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10228         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10229         GvNAMELEN(dstr) = GvNAMELEN(sstr);
10230         GvNAME(dstr)    = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10231         GvSTASH(dstr)   = hv_dup_inc(GvSTASH(sstr), param);
10232         GvFLAGS(dstr)   = GvFLAGS(sstr);
10233         GvGP(dstr)      = gp_dup(GvGP(sstr), param);
10234         (void)GpREFCNT_inc(GvGP(dstr));
10235         break;
10236     case SVt_PVIO:
10237         SvANY(dstr)     = new_XPVIO();
10238         SvCUR(dstr)     = SvCUR(sstr);
10239         SvLEN(dstr)     = SvLEN(sstr);
10240         SvIVX(dstr)     = SvIVX(sstr);
10241         SvNVX(dstr)     = SvNVX(sstr);
10242         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10243         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10244         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10245         IoIFP(dstr)     = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10246         if (IoOFP(sstr) == IoIFP(sstr))
10247             IoOFP(dstr) = IoIFP(dstr);
10248         else
10249             IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10250         /* PL_rsfp_filters entries have fake IoDIRP() */
10251         if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10252             IoDIRP(dstr)        = dirp_dup(IoDIRP(sstr));
10253         else
10254             IoDIRP(dstr)        = IoDIRP(sstr);
10255         IoLINES(dstr)           = IoLINES(sstr);
10256         IoPAGE(dstr)            = IoPAGE(sstr);
10257         IoPAGE_LEN(dstr)        = IoPAGE_LEN(sstr);
10258         IoLINES_LEFT(dstr)      = IoLINES_LEFT(sstr);
10259         if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10260             /* I have no idea why fake dirp (rsfps)
10261                should be treaded differently but otherwise
10262                we end up with leaks -- sky*/
10263             IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(sstr), param);
10264             IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(sstr), param);
10265             IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10266         } else {
10267             IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(sstr), param);
10268             IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(sstr), param);
10269             IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(sstr), param);
10270         }
10271         IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(sstr));
10272         IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(sstr));
10273         IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(sstr));
10274         IoSUBPROCESS(dstr)      = IoSUBPROCESS(sstr);
10275         IoTYPE(dstr)            = IoTYPE(sstr);
10276         IoFLAGS(dstr)           = IoFLAGS(sstr);
10277         break;
10278     case SVt_PVAV:
10279         SvANY(dstr)     = new_XPVAV();
10280         SvCUR(dstr)     = SvCUR(sstr);
10281         SvLEN(dstr)     = SvLEN(sstr);
10282         SvIVX(dstr)     = SvIVX(sstr);
10283         SvNVX(dstr)     = SvNVX(sstr);
10284         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10285         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10286         AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10287         AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10288         if (AvARRAY((AV*)sstr)) {
10289             SV **dst_ary, **src_ary;
10290             SSize_t items = AvFILLp((AV*)sstr) + 1;
10291
10292             src_ary = AvARRAY((AV*)sstr);
10293             Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10294             ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10295             SvPVX(dstr) = (char*)dst_ary;
10296             AvALLOC((AV*)dstr) = dst_ary;
10297             if (AvREAL((AV*)sstr)) {
10298                 while (items-- > 0)
10299                     *dst_ary++ = sv_dup_inc(*src_ary++, param);
10300             }
10301             else {
10302                 while (items-- > 0)
10303                     *dst_ary++ = sv_dup(*src_ary++, param);
10304             }
10305             items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10306             while (items-- > 0) {
10307                 *dst_ary++ = &PL_sv_undef;
10308             }
10309         }
10310         else {
10311             SvPVX(dstr)         = Nullch;
10312             AvALLOC((AV*)dstr)  = (SV**)NULL;
10313         }
10314         break;
10315     case SVt_PVHV:
10316         SvANY(dstr)     = new_XPVHV();
10317         SvCUR(dstr)     = SvCUR(sstr);
10318         SvLEN(dstr)     = SvLEN(sstr);
10319         SvIVX(dstr)     = SvIVX(sstr);
10320         SvNVX(dstr)     = SvNVX(sstr);
10321         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10322         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10323         HvRITER((HV*)dstr)      = HvRITER((HV*)sstr);
10324         if (HvARRAY((HV*)sstr)) {
10325             STRLEN i = 0;
10326             XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10327             XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10328             Newz(0, dxhv->xhv_array,
10329                  PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10330             while (i <= sxhv->xhv_max) {
10331                 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10332                                                     (bool)!!HvSHAREKEYS(sstr),
10333                                                     param);
10334                 ++i;
10335             }
10336             dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10337                                      (bool)!!HvSHAREKEYS(sstr), param);
10338         }
10339         else {
10340             SvPVX(dstr)         = Nullch;
10341             HvEITER((HV*)dstr)  = (HE*)NULL;
10342         }
10343         HvPMROOT((HV*)dstr)     = HvPMROOT((HV*)sstr);          /* XXX */
10344         HvNAME((HV*)dstr)       = SAVEPV(HvNAME((HV*)sstr));
10345     /* Record stashes for possible cloning in Perl_clone(). */
10346         if(HvNAME((HV*)dstr))
10347             av_push(param->stashes, dstr);
10348         break;
10349     case SVt_PVFM:
10350         SvANY(dstr)     = new_XPVFM();
10351         FmLINES(dstr)   = FmLINES(sstr);
10352         goto dup_pvcv;
10353         /* NOTREACHED */
10354     case SVt_PVCV:
10355         SvANY(dstr)     = new_XPVCV();
10356         dup_pvcv:
10357         SvCUR(dstr)     = SvCUR(sstr);
10358         SvLEN(dstr)     = SvLEN(sstr);
10359         SvIVX(dstr)     = SvIVX(sstr);
10360         SvNVX(dstr)     = SvNVX(sstr);
10361         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10362         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10363         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10364         CvSTASH(dstr)   = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10365         CvSTART(dstr)   = CvSTART(sstr);
10366         CvROOT(dstr)    = OpREFCNT_inc(CvROOT(sstr));
10367         CvXSUB(dstr)    = CvXSUB(sstr);
10368         CvXSUBANY(dstr) = CvXSUBANY(sstr);
10369         if (CvCONST(sstr)) {
10370             CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10371                 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10372                 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10373         }
10374         CvGV(dstr)      = gv_dup(CvGV(sstr), param);
10375         if (param->flags & CLONEf_COPY_STACKS) {
10376           CvDEPTH(dstr) = CvDEPTH(sstr);
10377         } else {
10378           CvDEPTH(dstr) = 0;
10379         }
10380         PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10381         CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10382         CvOUTSIDE(dstr) =
10383                 CvWEAKOUTSIDE(sstr)
10384                         ? cv_dup(    CvOUTSIDE(sstr), param)
10385                         : cv_dup_inc(CvOUTSIDE(sstr), param);
10386         CvFLAGS(dstr)   = CvFLAGS(sstr);
10387         CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10388         break;
10389     default:
10390         Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10391         break;
10392     }
10393
10394     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10395         ++PL_sv_objcount;
10396
10397     return dstr;
10398  }
10399
10400 /* duplicate a context */
10401
10402 PERL_CONTEXT *
10403 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10404 {
10405     PERL_CONTEXT *ncxs;
10406
10407     if (!cxs)
10408         return (PERL_CONTEXT*)NULL;
10409
10410     /* look for it in the table first */
10411     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10412     if (ncxs)
10413         return ncxs;
10414
10415     /* create anew and remember what it is */
10416     Newz(56, ncxs, max + 1, PERL_CONTEXT);
10417     ptr_table_store(PL_ptr_table, cxs, ncxs);
10418
10419     while (ix >= 0) {
10420         PERL_CONTEXT *cx = &cxs[ix];
10421         PERL_CONTEXT *ncx = &ncxs[ix];
10422         ncx->cx_type    = cx->cx_type;
10423         if (CxTYPE(cx) == CXt_SUBST) {
10424             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10425         }
10426         else {
10427             ncx->blk_oldsp      = cx->blk_oldsp;
10428             ncx->blk_oldcop     = cx->blk_oldcop;
10429             ncx->blk_oldretsp   = cx->blk_oldretsp;
10430             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
10431             ncx->blk_oldscopesp = cx->blk_oldscopesp;
10432             ncx->blk_oldpm      = cx->blk_oldpm;
10433             ncx->blk_gimme      = cx->blk_gimme;
10434             switch (CxTYPE(cx)) {
10435             case CXt_SUB:
10436                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
10437                                            ? cv_dup_inc(cx->blk_sub.cv, param)
10438                                            : cv_dup(cx->blk_sub.cv,param));
10439                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
10440                                            ? av_dup_inc(cx->blk_sub.argarray, param)
10441                                            : Nullav);
10442                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
10443                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
10444                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10445                 ncx->blk_sub.lval       = cx->blk_sub.lval;
10446                 break;
10447             case CXt_EVAL:
10448                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10449                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10450                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10451                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10452                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
10453                 break;
10454             case CXt_LOOP:
10455                 ncx->blk_loop.label     = cx->blk_loop.label;
10456                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
10457                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
10458                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
10459                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
10460                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
10461                                            ? cx->blk_loop.iterdata
10462                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
10463                 ncx->blk_loop.oldcomppad
10464                     = (PAD*)ptr_table_fetch(PL_ptr_table,
10465                                             cx->blk_loop.oldcomppad);
10466                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
10467                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
10468                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
10469                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
10470                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
10471                 break;
10472             case CXt_FORMAT:
10473                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
10474                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
10475                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10476                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10477                 break;
10478             case CXt_BLOCK:
10479             case CXt_NULL:
10480                 break;
10481             }
10482         }
10483         --ix;
10484     }
10485     return ncxs;
10486 }
10487
10488 /* duplicate a stack info structure */
10489
10490 PERL_SI *
10491 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10492 {
10493     PERL_SI *nsi;
10494
10495     if (!si)
10496         return (PERL_SI*)NULL;
10497
10498     /* look for it in the table first */
10499     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10500     if (nsi)
10501         return nsi;
10502
10503     /* create anew and remember what it is */
10504     Newz(56, nsi, 1, PERL_SI);
10505     ptr_table_store(PL_ptr_table, si, nsi);
10506
10507     nsi->si_stack       = av_dup_inc(si->si_stack, param);
10508     nsi->si_cxix        = si->si_cxix;
10509     nsi->si_cxmax       = si->si_cxmax;
10510     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10511     nsi->si_type        = si->si_type;
10512     nsi->si_prev        = si_dup(si->si_prev, param);
10513     nsi->si_next        = si_dup(si->si_next, param);
10514     nsi->si_markoff     = si->si_markoff;
10515
10516     return nsi;
10517 }
10518
10519 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
10520 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
10521 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
10522 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
10523 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
10524 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
10525 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
10526 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
10527 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
10528 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
10529 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
10530 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
10531 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10532 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10533
10534 /* XXXXX todo */
10535 #define pv_dup_inc(p)   SAVEPV(p)
10536 #define pv_dup(p)       SAVEPV(p)
10537 #define svp_dup_inc(p,pp)       any_dup(p,pp)
10538
10539 /* map any object to the new equivent - either something in the
10540  * ptr table, or something in the interpreter structure
10541  */
10542
10543 void *
10544 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10545 {
10546     void *ret;
10547
10548     if (!v)
10549         return (void*)NULL;
10550
10551     /* look for it in the table first */
10552     ret = ptr_table_fetch(PL_ptr_table, v);
10553     if (ret)
10554         return ret;
10555
10556     /* see if it is part of the interpreter structure */
10557     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10558         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10559     else {
10560         ret = v;
10561     }
10562
10563     return ret;
10564 }
10565
10566 /* duplicate the save stack */
10567
10568 ANY *
10569 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10570 {
10571     ANY *ss     = proto_perl->Tsavestack;
10572     I32 ix      = proto_perl->Tsavestack_ix;
10573     I32 max     = proto_perl->Tsavestack_max;
10574     ANY *nss;
10575     SV *sv;
10576     GV *gv;
10577     AV *av;
10578     HV *hv;
10579     void* ptr;
10580     int intval;
10581     long longval;
10582     GP *gp;
10583     IV iv;
10584     I32 i;
10585     char *c = NULL;
10586     void (*dptr) (void*);
10587     void (*dxptr) (pTHX_ void*);
10588     OP *o;
10589
10590     Newz(54, nss, max, ANY);
10591
10592     while (ix > 0) {
10593         i = POPINT(ss,ix);
10594         TOPINT(nss,ix) = i;
10595         switch (i) {
10596         case SAVEt_ITEM:                        /* normal string */
10597             sv = (SV*)POPPTR(ss,ix);
10598             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10599             sv = (SV*)POPPTR(ss,ix);
10600             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10601             break;
10602         case SAVEt_SV:                          /* scalar reference */
10603             sv = (SV*)POPPTR(ss,ix);
10604             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10605             gv = (GV*)POPPTR(ss,ix);
10606             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10607             break;
10608         case SAVEt_GENERIC_PVREF:               /* generic char* */
10609             c = (char*)POPPTR(ss,ix);
10610             TOPPTR(nss,ix) = pv_dup(c);
10611             ptr = POPPTR(ss,ix);
10612             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10613             break;
10614         case SAVEt_SHARED_PVREF:                /* char* in shared space */
10615             c = (char*)POPPTR(ss,ix);
10616             TOPPTR(nss,ix) = savesharedpv(c);
10617             ptr = POPPTR(ss,ix);
10618             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10619             break;
10620         case SAVEt_GENERIC_SVREF:               /* generic sv */
10621         case SAVEt_SVREF:                       /* scalar reference */
10622             sv = (SV*)POPPTR(ss,ix);
10623             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10624             ptr = POPPTR(ss,ix);
10625             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10626             break;
10627         case SAVEt_AV:                          /* array reference */
10628             av = (AV*)POPPTR(ss,ix);
10629             TOPPTR(nss,ix) = av_dup_inc(av, param);
10630             gv = (GV*)POPPTR(ss,ix);
10631             TOPPTR(nss,ix) = gv_dup(gv, param);
10632             break;
10633         case SAVEt_HV:                          /* hash reference */
10634             hv = (HV*)POPPTR(ss,ix);
10635             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10636             gv = (GV*)POPPTR(ss,ix);
10637             TOPPTR(nss,ix) = gv_dup(gv, param);
10638             break;
10639         case SAVEt_INT:                         /* int reference */
10640             ptr = POPPTR(ss,ix);
10641             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10642             intval = (int)POPINT(ss,ix);
10643             TOPINT(nss,ix) = intval;
10644             break;
10645         case SAVEt_LONG:                        /* long reference */
10646             ptr = POPPTR(ss,ix);
10647             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10648             longval = (long)POPLONG(ss,ix);
10649             TOPLONG(nss,ix) = longval;
10650             break;
10651         case SAVEt_I32:                         /* I32 reference */
10652         case SAVEt_I16:                         /* I16 reference */
10653         case SAVEt_I8:                          /* I8 reference */
10654             ptr = POPPTR(ss,ix);
10655             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10656             i = POPINT(ss,ix);
10657             TOPINT(nss,ix) = i;
10658             break;
10659         case SAVEt_IV:                          /* IV reference */
10660             ptr = POPPTR(ss,ix);
10661             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10662             iv = POPIV(ss,ix);
10663             TOPIV(nss,ix) = iv;
10664             break;
10665         case SAVEt_SPTR:                        /* SV* reference */
10666             ptr = POPPTR(ss,ix);
10667             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10668             sv = (SV*)POPPTR(ss,ix);
10669             TOPPTR(nss,ix) = sv_dup(sv, param);
10670             break;
10671         case SAVEt_VPTR:                        /* random* reference */
10672             ptr = POPPTR(ss,ix);
10673             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10674             ptr = POPPTR(ss,ix);
10675             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10676             break;
10677         case SAVEt_PPTR:                        /* char* reference */
10678             ptr = POPPTR(ss,ix);
10679             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10680             c = (char*)POPPTR(ss,ix);
10681             TOPPTR(nss,ix) = pv_dup(c);
10682             break;
10683         case SAVEt_HPTR:                        /* HV* reference */
10684             ptr = POPPTR(ss,ix);
10685             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10686             hv = (HV*)POPPTR(ss,ix);
10687             TOPPTR(nss,ix) = hv_dup(hv, param);
10688             break;
10689         case SAVEt_APTR:                        /* AV* reference */
10690             ptr = POPPTR(ss,ix);
10691             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10692             av = (AV*)POPPTR(ss,ix);
10693             TOPPTR(nss,ix) = av_dup(av, param);
10694             break;
10695         case SAVEt_NSTAB:
10696             gv = (GV*)POPPTR(ss,ix);
10697             TOPPTR(nss,ix) = gv_dup(gv, param);
10698             break;
10699         case SAVEt_GP:                          /* scalar reference */
10700             gp = (GP*)POPPTR(ss,ix);
10701             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10702             (void)GpREFCNT_inc(gp);
10703             gv = (GV*)POPPTR(ss,ix);
10704             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10705             c = (char*)POPPTR(ss,ix);
10706             TOPPTR(nss,ix) = pv_dup(c);
10707             iv = POPIV(ss,ix);
10708             TOPIV(nss,ix) = iv;
10709             iv = POPIV(ss,ix);
10710             TOPIV(nss,ix) = iv;
10711             break;
10712         case SAVEt_FREESV:
10713         case SAVEt_MORTALIZESV:
10714             sv = (SV*)POPPTR(ss,ix);
10715             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10716             break;
10717         case SAVEt_FREEOP:
10718             ptr = POPPTR(ss,ix);
10719             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10720                 /* these are assumed to be refcounted properly */
10721                 switch (((OP*)ptr)->op_type) {
10722                 case OP_LEAVESUB:
10723                 case OP_LEAVESUBLV:
10724                 case OP_LEAVEEVAL:
10725                 case OP_LEAVE:
10726                 case OP_SCOPE:
10727                 case OP_LEAVEWRITE:
10728                     TOPPTR(nss,ix) = ptr;
10729                     o = (OP*)ptr;
10730                     OpREFCNT_inc(o);
10731                     break;
10732                 default:
10733                     TOPPTR(nss,ix) = Nullop;
10734                     break;
10735                 }
10736             }
10737             else
10738                 TOPPTR(nss,ix) = Nullop;
10739             break;
10740         case SAVEt_FREEPV:
10741             c = (char*)POPPTR(ss,ix);
10742             TOPPTR(nss,ix) = pv_dup_inc(c);
10743             break;
10744         case SAVEt_CLEARSV:
10745             longval = POPLONG(ss,ix);
10746             TOPLONG(nss,ix) = longval;
10747             break;
10748         case SAVEt_DELETE:
10749             hv = (HV*)POPPTR(ss,ix);
10750             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10751             c = (char*)POPPTR(ss,ix);
10752             TOPPTR(nss,ix) = pv_dup_inc(c);
10753             i = POPINT(ss,ix);
10754             TOPINT(nss,ix) = i;
10755             break;
10756         case SAVEt_DESTRUCTOR:
10757             ptr = POPPTR(ss,ix);
10758             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10759             dptr = POPDPTR(ss,ix);
10760             TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10761             break;
10762         case SAVEt_DESTRUCTOR_X:
10763             ptr = POPPTR(ss,ix);
10764             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10765             dxptr = POPDXPTR(ss,ix);
10766             TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10767             break;
10768         case SAVEt_REGCONTEXT:
10769         case SAVEt_ALLOC:
10770             i = POPINT(ss,ix);
10771             TOPINT(nss,ix) = i;
10772             ix -= i;
10773             break;
10774         case SAVEt_STACK_POS:           /* Position on Perl stack */
10775             i = POPINT(ss,ix);
10776             TOPINT(nss,ix) = i;
10777             break;
10778         case SAVEt_AELEM:               /* array element */
10779             sv = (SV*)POPPTR(ss,ix);
10780             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10781             i = POPINT(ss,ix);
10782             TOPINT(nss,ix) = i;
10783             av = (AV*)POPPTR(ss,ix);
10784             TOPPTR(nss,ix) = av_dup_inc(av, param);
10785             break;
10786         case SAVEt_HELEM:               /* hash element */
10787             sv = (SV*)POPPTR(ss,ix);
10788             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10789             sv = (SV*)POPPTR(ss,ix);
10790             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10791             hv = (HV*)POPPTR(ss,ix);
10792             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10793             break;
10794         case SAVEt_OP:
10795             ptr = POPPTR(ss,ix);
10796             TOPPTR(nss,ix) = ptr;
10797             break;
10798         case SAVEt_HINTS:
10799             i = POPINT(ss,ix);
10800             TOPINT(nss,ix) = i;
10801             break;
10802         case SAVEt_COMPPAD:
10803             av = (AV*)POPPTR(ss,ix);
10804             TOPPTR(nss,ix) = av_dup(av, param);
10805             break;
10806         case SAVEt_PADSV:
10807             longval = (long)POPLONG(ss,ix);
10808             TOPLONG(nss,ix) = longval;
10809             ptr = POPPTR(ss,ix);
10810             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10811             sv = (SV*)POPPTR(ss,ix);
10812             TOPPTR(nss,ix) = sv_dup(sv, param);
10813             break;
10814         case SAVEt_BOOL:
10815             ptr = POPPTR(ss,ix);
10816             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10817             longval = (long)POPBOOL(ss,ix);
10818             TOPBOOL(nss,ix) = (bool)longval;
10819             break;
10820         case SAVEt_SET_SVFLAGS:
10821             i = POPINT(ss,ix);
10822             TOPINT(nss,ix) = i;
10823             i = POPINT(ss,ix);
10824             TOPINT(nss,ix) = i;
10825             sv = (SV*)POPPTR(ss,ix);
10826             TOPPTR(nss,ix) = sv_dup(sv, param);
10827             break;
10828         default:
10829             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10830         }
10831     }
10832
10833     return nss;
10834 }
10835
10836 /*
10837 =for apidoc perl_clone
10838
10839 Create and return a new interpreter by cloning the current one.
10840
10841 perl_clone takes these flags as parameters:
10842
10843 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10844 without it we only clone the data and zero the stacks,
10845 with it we copy the stacks and the new perl interpreter is
10846 ready to run at the exact same point as the previous one.
10847 The pseudo-fork code uses COPY_STACKS while the
10848 threads->new doesn't.
10849
10850 CLONEf_KEEP_PTR_TABLE
10851 perl_clone keeps a ptr_table with the pointer of the old
10852 variable as a key and the new variable as a value,
10853 this allows it to check if something has been cloned and not
10854 clone it again but rather just use the value and increase the
10855 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10856 the ptr_table using the function
10857 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10858 reason to keep it around is if you want to dup some of your own
10859 variable who are outside the graph perl scans, example of this
10860 code is in threads.xs create
10861
10862 CLONEf_CLONE_HOST
10863 This is a win32 thing, it is ignored on unix, it tells perls
10864 win32host code (which is c++) to clone itself, this is needed on
10865 win32 if you want to run two threads at the same time,
10866 if you just want to do some stuff in a separate perl interpreter
10867 and then throw it away and return to the original one,
10868 you don't need to do anything.
10869
10870 =cut
10871 */
10872
10873 /* XXX the above needs expanding by someone who actually understands it ! */
10874 EXTERN_C PerlInterpreter *
10875 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10876
10877 PerlInterpreter *
10878 perl_clone(PerlInterpreter *proto_perl, UV flags)
10879 {
10880 #ifdef PERL_IMPLICIT_SYS
10881
10882    /* perlhost.h so we need to call into it
10883    to clone the host, CPerlHost should have a c interface, sky */
10884
10885    if (flags & CLONEf_CLONE_HOST) {
10886        return perl_clone_host(proto_perl,flags);
10887    }
10888    return perl_clone_using(proto_perl, flags,
10889                             proto_perl->IMem,
10890                             proto_perl->IMemShared,
10891                             proto_perl->IMemParse,
10892                             proto_perl->IEnv,
10893                             proto_perl->IStdIO,
10894                             proto_perl->ILIO,
10895                             proto_perl->IDir,
10896                             proto_perl->ISock,
10897                             proto_perl->IProc);
10898 }
10899
10900 PerlInterpreter *
10901 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10902                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
10903                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10904                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10905                  struct IPerlDir* ipD, struct IPerlSock* ipS,
10906                  struct IPerlProc* ipP)
10907 {
10908     /* XXX many of the string copies here can be optimized if they're
10909      * constants; they need to be allocated as common memory and just
10910      * their pointers copied. */
10911
10912     IV i;
10913     CLONE_PARAMS clone_params;
10914     CLONE_PARAMS* param = &clone_params;
10915
10916     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10917     PERL_SET_THX(my_perl);
10918
10919 #  ifdef DEBUGGING
10920     Poison(my_perl, 1, PerlInterpreter);
10921     PL_markstack = 0;
10922     PL_scopestack = 0;
10923     PL_savestack = 0;
10924     PL_savestack_ix = 0;
10925     PL_savestack_max = -1;
10926     PL_retstack = 0;
10927     PL_sig_pending = 0;
10928     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10929 #  else /* !DEBUGGING */
10930     Zero(my_perl, 1, PerlInterpreter);
10931 #  endif        /* DEBUGGING */
10932
10933     /* host pointers */
10934     PL_Mem              = ipM;
10935     PL_MemShared        = ipMS;
10936     PL_MemParse         = ipMP;
10937     PL_Env              = ipE;
10938     PL_StdIO            = ipStd;
10939     PL_LIO              = ipLIO;
10940     PL_Dir              = ipD;
10941     PL_Sock             = ipS;
10942     PL_Proc             = ipP;
10943 #else           /* !PERL_IMPLICIT_SYS */
10944     IV i;
10945     CLONE_PARAMS clone_params;
10946     CLONE_PARAMS* param = &clone_params;
10947     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10948     PERL_SET_THX(my_perl);
10949
10950
10951
10952 #    ifdef DEBUGGING
10953     Poison(my_perl, 1, PerlInterpreter);
10954     PL_markstack = 0;
10955     PL_scopestack = 0;
10956     PL_savestack = 0;
10957     PL_savestack_ix = 0;
10958     PL_savestack_max = -1;
10959     PL_retstack = 0;
10960     PL_sig_pending = 0;
10961     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10962 #    else       /* !DEBUGGING */
10963     Zero(my_perl, 1, PerlInterpreter);
10964 #    endif      /* DEBUGGING */
10965 #endif          /* PERL_IMPLICIT_SYS */
10966     param->flags = flags;
10967     param->proto_perl = proto_perl;
10968
10969     /* arena roots */
10970     PL_xiv_arenaroot    = NULL;
10971     PL_xiv_root         = NULL;
10972     PL_xnv_arenaroot    = NULL;
10973     PL_xnv_root         = NULL;
10974     PL_xrv_arenaroot    = NULL;
10975     PL_xrv_root         = NULL;
10976     PL_xpv_arenaroot    = NULL;
10977     PL_xpv_root         = NULL;
10978     PL_xpviv_arenaroot  = NULL;
10979     PL_xpviv_root       = NULL;
10980     PL_xpvnv_arenaroot  = NULL;
10981     PL_xpvnv_root       = NULL;
10982     PL_xpvcv_arenaroot  = NULL;
10983     PL_xpvcv_root       = NULL;
10984     PL_xpvav_arenaroot  = NULL;
10985     PL_xpvav_root       = NULL;
10986     PL_xpvhv_arenaroot  = NULL;
10987     PL_xpvhv_root       = NULL;
10988     PL_xpvmg_arenaroot  = NULL;
10989     PL_xpvmg_root       = NULL;
10990     PL_xpvlv_arenaroot  = NULL;
10991     PL_xpvlv_root       = NULL;
10992     PL_xpvbm_arenaroot  = NULL;
10993     PL_xpvbm_root       = NULL;
10994     PL_he_arenaroot     = NULL;
10995     PL_he_root          = NULL;
10996     PL_nice_chunk       = NULL;
10997     PL_nice_chunk_size  = 0;
10998     PL_sv_count         = 0;
10999     PL_sv_objcount      = 0;
11000     PL_sv_root          = Nullsv;
11001     PL_sv_arenaroot     = Nullsv;
11002
11003     PL_debug            = proto_perl->Idebug;
11004
11005 #ifdef USE_REENTRANT_API
11006     /* XXX: things like -Dm will segfault here in perlio, but doing
11007      *  PERL_SET_CONTEXT(proto_perl);
11008      * breaks too many other things
11009      */
11010     Perl_reentrant_init(aTHX);
11011 #endif
11012
11013     /* create SV map for pointer relocation */
11014     PL_ptr_table = ptr_table_new();
11015
11016     /* initialize these special pointers as early as possible */
11017     SvANY(&PL_sv_undef)         = NULL;
11018     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
11019     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
11020     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11021
11022     SvANY(&PL_sv_no)            = new_XPVNV();
11023     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
11024     SvFLAGS(&PL_sv_no)          = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11025     SvPVX(&PL_sv_no)            = SAVEPVN(PL_No, 0);
11026     SvCUR(&PL_sv_no)            = 0;
11027     SvLEN(&PL_sv_no)            = 1;
11028     SvNVX(&PL_sv_no)            = 0;
11029     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11030
11031     SvANY(&PL_sv_yes)           = new_XPVNV();
11032     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
11033     SvFLAGS(&PL_sv_yes)         = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11034     SvPVX(&PL_sv_yes)           = SAVEPVN(PL_Yes, 1);
11035     SvCUR(&PL_sv_yes)           = 1;
11036     SvLEN(&PL_sv_yes)           = 2;
11037     SvNVX(&PL_sv_yes)           = 1;
11038     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11039
11040     /* create (a non-shared!) shared string table */
11041     PL_strtab           = newHV();
11042     HvSHAREKEYS_off(PL_strtab);
11043     hv_ksplit(PL_strtab, 512);
11044     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11045
11046     PL_compiling = proto_perl->Icompiling;
11047
11048     /* These two PVs will be free'd special way so must set them same way op.c does */
11049     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11050     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11051
11052     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
11053     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11054
11055     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11056     if (!specialWARN(PL_compiling.cop_warnings))
11057         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11058     if (!specialCopIO(PL_compiling.cop_io))
11059         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11060     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11061
11062     /* pseudo environmental stuff */
11063     PL_origargc         = proto_perl->Iorigargc;
11064     PL_origargv         = proto_perl->Iorigargv;
11065
11066     param->stashes      = newAV();  /* Setup array of objects to call clone on */
11067
11068 #ifdef PERLIO_LAYERS
11069     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11070     PerlIO_clone(aTHX_ proto_perl, param);
11071 #endif
11072
11073     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
11074     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
11075     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
11076     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
11077     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
11078     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
11079
11080     /* switches */
11081     PL_minus_c          = proto_perl->Iminus_c;
11082     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
11083     PL_localpatches     = proto_perl->Ilocalpatches;
11084     PL_splitstr         = proto_perl->Isplitstr;
11085     PL_preprocess       = proto_perl->Ipreprocess;
11086     PL_minus_n          = proto_perl->Iminus_n;
11087     PL_minus_p          = proto_perl->Iminus_p;
11088     PL_minus_l          = proto_perl->Iminus_l;
11089     PL_minus_a          = proto_perl->Iminus_a;
11090     PL_minus_F          = proto_perl->Iminus_F;
11091     PL_doswitches       = proto_perl->Idoswitches;
11092     PL_dowarn           = proto_perl->Idowarn;
11093     PL_doextract        = proto_perl->Idoextract;
11094     PL_sawampersand     = proto_perl->Isawampersand;
11095     PL_unsafe           = proto_perl->Iunsafe;
11096     PL_inplace          = SAVEPV(proto_perl->Iinplace);
11097     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
11098     PL_perldb           = proto_perl->Iperldb;
11099     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11100     PL_exit_flags       = proto_perl->Iexit_flags;
11101
11102     /* magical thingies */
11103     /* XXX time(&PL_basetime) when asked for? */
11104     PL_basetime         = proto_perl->Ibasetime;
11105     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
11106
11107     PL_maxsysfd         = proto_perl->Imaxsysfd;
11108     PL_multiline        = proto_perl->Imultiline;
11109     PL_statusvalue      = proto_perl->Istatusvalue;
11110 #ifdef VMS
11111     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
11112 #endif
11113     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
11114
11115     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
11116     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
11117     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
11118
11119     /* Clone the regex array */
11120     PL_regex_padav = newAV();
11121     {
11122         I32 len = av_len((AV*)proto_perl->Iregex_padav);
11123         SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11124         av_push(PL_regex_padav,
11125                 sv_dup_inc(regexen[0],param));
11126         for(i = 1; i <= len; i++) {
11127             if(SvREPADTMP(regexen[i])) {
11128               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11129             } else {
11130                 av_push(PL_regex_padav,
11131                     SvREFCNT_inc(
11132                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11133                              SvIVX(regexen[i])), param)))
11134                        ));
11135             }
11136         }
11137     }
11138     PL_regex_pad = AvARRAY(PL_regex_padav);
11139
11140     /* shortcuts to various I/O objects */
11141     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
11142     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
11143     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
11144     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
11145     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
11146     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
11147
11148     /* shortcuts to regexp stuff */
11149     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
11150
11151     /* shortcuts to misc objects */
11152     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
11153
11154     /* shortcuts to debugging objects */
11155     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
11156     PL_DBline           = gv_dup(proto_perl->IDBline, param);
11157     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
11158     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
11159     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
11160     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
11161     PL_DBassertion      = sv_dup(proto_perl->IDBassertion, param);
11162     PL_lineary          = av_dup(proto_perl->Ilineary, param);
11163     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
11164
11165     /* symbol tables */
11166     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
11167     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
11168     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
11169     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
11170     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
11171
11172     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
11173     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
11174     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
11175     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
11176     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
11177     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
11178
11179     PL_sub_generation   = proto_perl->Isub_generation;
11180
11181     /* funky return mechanisms */
11182     PL_forkprocess      = proto_perl->Iforkprocess;
11183
11184     /* subprocess state */
11185     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
11186
11187     /* internal state */
11188     PL_tainting         = proto_perl->Itainting;
11189     PL_taint_warn       = proto_perl->Itaint_warn;
11190     PL_maxo             = proto_perl->Imaxo;
11191     if (proto_perl->Iop_mask)
11192         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11193     else
11194         PL_op_mask      = Nullch;
11195     /* PL_asserting        = proto_perl->Iasserting; */
11196
11197     /* current interpreter roots */
11198     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
11199     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
11200     PL_main_start       = proto_perl->Imain_start;
11201     PL_eval_root        = proto_perl->Ieval_root;
11202     PL_eval_start       = proto_perl->Ieval_start;
11203
11204     /* runtime control stuff */
11205     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11206     PL_copline          = proto_perl->Icopline;
11207
11208     PL_filemode         = proto_perl->Ifilemode;
11209     PL_lastfd           = proto_perl->Ilastfd;
11210     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
11211     PL_Argv             = NULL;
11212     PL_Cmd              = Nullch;
11213     PL_gensym           = proto_perl->Igensym;
11214     PL_preambled        = proto_perl->Ipreambled;
11215     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
11216     PL_laststatval      = proto_perl->Ilaststatval;
11217     PL_laststype        = proto_perl->Ilaststype;
11218     PL_mess_sv          = Nullsv;
11219
11220     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
11221     PL_ofmt             = SAVEPV(proto_perl->Iofmt);
11222
11223     /* interpreter atexit processing */
11224     PL_exitlistlen      = proto_perl->Iexitlistlen;
11225     if (PL_exitlistlen) {
11226         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11227         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11228     }
11229     else
11230         PL_exitlist     = (PerlExitListEntry*)NULL;
11231     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
11232     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
11233     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11234
11235     PL_profiledata      = NULL;
11236     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
11237     /* PL_rsfp_filters entries have fake IoDIRP() */
11238     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
11239
11240     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
11241
11242     PAD_CLONE_VARS(proto_perl, param);
11243
11244 #ifdef HAVE_INTERP_INTERN
11245     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11246 #endif
11247
11248     /* more statics moved here */
11249     PL_generation       = proto_perl->Igeneration;
11250     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
11251
11252     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
11253     PL_in_clean_all     = proto_perl->Iin_clean_all;
11254
11255     PL_uid              = proto_perl->Iuid;
11256     PL_euid             = proto_perl->Ieuid;
11257     PL_gid              = proto_perl->Igid;
11258     PL_egid             = proto_perl->Iegid;
11259     PL_nomemok          = proto_perl->Inomemok;
11260     PL_an               = proto_perl->Ian;
11261     PL_op_seqmax        = proto_perl->Iop_seqmax;
11262     PL_evalseq          = proto_perl->Ievalseq;
11263     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
11264     PL_origalen         = proto_perl->Iorigalen;
11265     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
11266     PL_osname           = SAVEPV(proto_perl->Iosname);
11267     PL_sh_path_compat   = proto_perl->Ish_path_compat; /* XXX never deallocated */
11268     PL_sighandlerp      = proto_perl->Isighandlerp;
11269
11270
11271     PL_runops           = proto_perl->Irunops;
11272
11273     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11274
11275 #ifdef CSH
11276     PL_cshlen           = proto_perl->Icshlen;
11277     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
11278 #endif
11279
11280     PL_lex_state        = proto_perl->Ilex_state;
11281     PL_lex_defer        = proto_perl->Ilex_defer;
11282     PL_lex_expect       = proto_perl->Ilex_expect;
11283     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
11284     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
11285     PL_lex_starts       = proto_perl->Ilex_starts;
11286     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
11287     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
11288     PL_lex_op           = proto_perl->Ilex_op;
11289     PL_lex_inpat        = proto_perl->Ilex_inpat;
11290     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
11291     PL_lex_brackets     = proto_perl->Ilex_brackets;
11292     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11293     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
11294     PL_lex_casemods     = proto_perl->Ilex_casemods;
11295     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11296     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
11297
11298     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11299     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11300     PL_nexttoke         = proto_perl->Inexttoke;
11301
11302     /* XXX This is probably masking the deeper issue of why
11303      * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11304      * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11305      * (A little debugging with a watchpoint on it may help.)
11306      */
11307     if (SvANY(proto_perl->Ilinestr)) {
11308         PL_linestr              = sv_dup_inc(proto_perl->Ilinestr, param);
11309         i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11310         PL_bufptr               = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11311         i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11312         PL_oldbufptr    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11313         i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11314         PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11315         i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11316         PL_linestart    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11317     }
11318     else {
11319         PL_linestr = NEWSV(65,79);
11320         sv_upgrade(PL_linestr,SVt_PVIV);
11321         sv_setpvn(PL_linestr,"",0);
11322         PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11323     }
11324     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11325     PL_pending_ident    = proto_perl->Ipending_ident;
11326     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
11327
11328     PL_expect           = proto_perl->Iexpect;
11329
11330     PL_multi_start      = proto_perl->Imulti_start;
11331     PL_multi_end        = proto_perl->Imulti_end;
11332     PL_multi_open       = proto_perl->Imulti_open;
11333     PL_multi_close      = proto_perl->Imulti_close;
11334
11335     PL_error_count      = proto_perl->Ierror_count;
11336     PL_subline          = proto_perl->Isubline;
11337     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
11338
11339     /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11340     if (SvANY(proto_perl->Ilinestr)) {
11341         i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11342         PL_last_uni             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11343         i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11344         PL_last_lop             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11345         PL_last_lop_op  = proto_perl->Ilast_lop_op;
11346     }
11347     else {
11348         PL_last_uni     = SvPVX(PL_linestr);
11349         PL_last_lop     = SvPVX(PL_linestr);
11350         PL_last_lop_op  = 0;
11351     }
11352     PL_in_my            = proto_perl->Iin_my;
11353     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
11354 #ifdef FCRYPT
11355     PL_cryptseen        = proto_perl->Icryptseen;
11356 #endif
11357
11358     PL_hints            = proto_perl->Ihints;
11359
11360     PL_amagic_generation        = proto_perl->Iamagic_generation;
11361
11362 #ifdef USE_LOCALE_COLLATE
11363     PL_collation_ix     = proto_perl->Icollation_ix;
11364     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
11365     PL_collation_standard       = proto_perl->Icollation_standard;
11366     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
11367     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
11368 #endif /* USE_LOCALE_COLLATE */
11369
11370 #ifdef USE_LOCALE_NUMERIC
11371     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
11372     PL_numeric_standard = proto_perl->Inumeric_standard;
11373     PL_numeric_local    = proto_perl->Inumeric_local;
11374     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11375 #endif /* !USE_LOCALE_NUMERIC */
11376
11377     /* utf8 character classes */
11378     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11379     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11380     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11381     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11382     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
11383     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11384     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
11385     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
11386     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
11387     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
11388     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
11389     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
11390     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11391     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
11392     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11393     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11394     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11395     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11396     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11397     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11398
11399     /* Did the locale setup indicate UTF-8? */
11400     PL_utf8locale       = proto_perl->Iutf8locale;
11401     /* Unicode features (see perlrun/-C) */
11402     PL_unicode          = proto_perl->Iunicode;
11403
11404     /* Pre-5.8 signals control */
11405     PL_signals          = proto_perl->Isignals;
11406
11407     /* times() ticks per second */
11408     PL_clocktick        = proto_perl->Iclocktick;
11409
11410     /* Recursion stopper for PerlIO_find_layer */
11411     PL_in_load_module   = proto_perl->Iin_load_module;
11412
11413     /* sort() routine */
11414     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
11415
11416     /* Not really needed/useful since the reenrant_retint is "volatile",
11417      * but do it for consistency's sake. */
11418     PL_reentrant_retint = proto_perl->Ireentrant_retint;
11419
11420     /* Hooks to shared SVs and locks. */
11421     PL_sharehook        = proto_perl->Isharehook;
11422     PL_lockhook         = proto_perl->Ilockhook;
11423     PL_unlockhook       = proto_perl->Iunlockhook;
11424     PL_threadhook       = proto_perl->Ithreadhook;
11425
11426     PL_runops_std       = proto_perl->Irunops_std;
11427     PL_runops_dbg       = proto_perl->Irunops_dbg;
11428
11429 #ifdef THREADS_HAVE_PIDS
11430     PL_ppid             = proto_perl->Ippid;
11431 #endif
11432
11433     /* swatch cache */
11434     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
11435     PL_last_swash_klen  = 0;
11436     PL_last_swash_key[0]= '\0';
11437     PL_last_swash_tmps  = (U8*)NULL;
11438     PL_last_swash_slen  = 0;
11439
11440     /* perly.c globals */
11441     PL_yydebug          = proto_perl->Iyydebug;
11442     PL_yynerrs          = proto_perl->Iyynerrs;
11443     PL_yyerrflag        = proto_perl->Iyyerrflag;
11444     PL_yychar           = proto_perl->Iyychar;
11445     PL_yyval            = proto_perl->Iyyval;
11446     PL_yylval           = proto_perl->Iyylval;
11447
11448     PL_glob_index       = proto_perl->Iglob_index;
11449     PL_srand_called     = proto_perl->Isrand_called;
11450     PL_hash_seed        = proto_perl->Ihash_seed;
11451     PL_rehash_seed      = proto_perl->Irehash_seed;
11452     PL_uudmap['M']      = 0;            /* reinits on demand */
11453     PL_bitcount         = Nullch;       /* reinits on demand */
11454
11455     if (proto_perl->Ipsig_pend) {
11456         Newz(0, PL_psig_pend, SIG_SIZE, int);
11457     }
11458     else {
11459         PL_psig_pend    = (int*)NULL;
11460     }
11461
11462     if (proto_perl->Ipsig_ptr) {
11463         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
11464         Newz(0, PL_psig_name, SIG_SIZE, SV*);
11465         for (i = 1; i < SIG_SIZE; i++) {
11466             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11467             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11468         }
11469     }
11470     else {
11471         PL_psig_ptr     = (SV**)NULL;
11472         PL_psig_name    = (SV**)NULL;
11473     }
11474
11475     /* thrdvar.h stuff */
11476
11477     if (flags & CLONEf_COPY_STACKS) {
11478         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11479         PL_tmps_ix              = proto_perl->Ttmps_ix;
11480         PL_tmps_max             = proto_perl->Ttmps_max;
11481         PL_tmps_floor           = proto_perl->Ttmps_floor;
11482         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11483         i = 0;
11484         while (i <= PL_tmps_ix) {
11485             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11486             ++i;
11487         }
11488
11489         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11490         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11491         Newz(54, PL_markstack, i, I32);
11492         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
11493                                                   - proto_perl->Tmarkstack);
11494         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
11495                                                   - proto_perl->Tmarkstack);
11496         Copy(proto_perl->Tmarkstack, PL_markstack,
11497              PL_markstack_ptr - PL_markstack + 1, I32);
11498
11499         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11500          * NOTE: unlike the others! */
11501         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
11502         PL_scopestack_max       = proto_perl->Tscopestack_max;
11503         Newz(54, PL_scopestack, PL_scopestack_max, I32);
11504         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11505
11506         /* next push_return() sets PL_retstack[PL_retstack_ix]
11507          * NOTE: unlike the others! */
11508         PL_retstack_ix          = proto_perl->Tretstack_ix;
11509         PL_retstack_max         = proto_perl->Tretstack_max;
11510         Newz(54, PL_retstack, PL_retstack_max, OP*);
11511         Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11512
11513         /* NOTE: si_dup() looks at PL_markstack */
11514         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
11515
11516         /* PL_curstack          = PL_curstackinfo->si_stack; */
11517         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
11518         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
11519
11520         /* next PUSHs() etc. set *(PL_stack_sp+1) */
11521         PL_stack_base           = AvARRAY(PL_curstack);
11522         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
11523                                                    - proto_perl->Tstack_base);
11524         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
11525
11526         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11527          * NOTE: unlike the others! */
11528         PL_savestack_ix         = proto_perl->Tsavestack_ix;
11529         PL_savestack_max        = proto_perl->Tsavestack_max;
11530         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11531         PL_savestack            = ss_dup(proto_perl, param);
11532     }
11533     else {
11534         init_stacks();
11535         ENTER;                  /* perl_destruct() wants to LEAVE; */
11536     }
11537
11538     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
11539     PL_top_env          = &PL_start_env;
11540
11541     PL_op               = proto_perl->Top;
11542
11543     PL_Sv               = Nullsv;
11544     PL_Xpv              = (XPV*)NULL;
11545     PL_na               = proto_perl->Tna;
11546
11547     PL_statbuf          = proto_perl->Tstatbuf;
11548     PL_statcache        = proto_perl->Tstatcache;
11549     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
11550     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
11551 #ifdef HAS_TIMES
11552     PL_timesbuf         = proto_perl->Ttimesbuf;
11553 #endif
11554
11555     PL_tainted          = proto_perl->Ttainted;
11556     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
11557     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
11558     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
11559     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
11560     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
11561     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
11562     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
11563     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
11564     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
11565
11566     PL_restartop        = proto_perl->Trestartop;
11567     PL_in_eval          = proto_perl->Tin_eval;
11568     PL_delaymagic       = proto_perl->Tdelaymagic;
11569     PL_dirty            = proto_perl->Tdirty;
11570     PL_localizing       = proto_perl->Tlocalizing;
11571
11572 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11573     PL_protect          = proto_perl->Tprotect;
11574 #endif
11575     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
11576     PL_hv_fetch_ent_mh  = Nullhe;
11577     PL_modcount         = proto_perl->Tmodcount;
11578     PL_lastgotoprobe    = Nullop;
11579     PL_dumpindent       = proto_perl->Tdumpindent;
11580
11581     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11582     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
11583     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
11584     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
11585     PL_sortcxix         = proto_perl->Tsortcxix;
11586     PL_efloatbuf        = Nullch;               /* reinits on demand */
11587     PL_efloatsize       = 0;                    /* reinits on demand */
11588
11589     /* regex stuff */
11590
11591     PL_screamfirst      = NULL;
11592     PL_screamnext       = NULL;
11593     PL_maxscream        = -1;                   /* reinits on demand */
11594     PL_lastscream       = Nullsv;
11595
11596     PL_watchaddr        = NULL;
11597     PL_watchok          = Nullch;
11598
11599     PL_regdummy         = proto_perl->Tregdummy;
11600     PL_regprecomp       = Nullch;
11601     PL_regnpar          = 0;
11602     PL_regsize          = 0;
11603     PL_colorset         = 0;            /* reinits PL_colors[] */
11604     /*PL_colors[6]      = {0,0,0,0,0,0};*/
11605     PL_reginput         = Nullch;
11606     PL_regbol           = Nullch;
11607     PL_regeol           = Nullch;
11608     PL_regstartp        = (I32*)NULL;
11609     PL_regendp          = (I32*)NULL;
11610     PL_reglastparen     = (U32*)NULL;
11611     PL_reglastcloseparen        = (U32*)NULL;
11612     PL_regtill          = Nullch;
11613     PL_reg_start_tmp    = (char**)NULL;
11614     PL_reg_start_tmpl   = 0;
11615     PL_regdata          = (struct reg_data*)NULL;
11616     PL_bostr            = Nullch;
11617     PL_reg_flags        = 0;
11618     PL_reg_eval_set     = 0;
11619     PL_regnarrate       = 0;
11620     PL_regprogram       = (regnode*)NULL;
11621     PL_regindent        = 0;
11622     PL_regcc            = (CURCUR*)NULL;
11623     PL_reg_call_cc      = (struct re_cc_state*)NULL;
11624     PL_reg_re           = (regexp*)NULL;
11625     PL_reg_ganch        = Nullch;
11626     PL_reg_sv           = Nullsv;
11627     PL_reg_match_utf8   = FALSE;
11628     PL_reg_magic        = (MAGIC*)NULL;
11629     PL_reg_oldpos       = 0;
11630     PL_reg_oldcurpm     = (PMOP*)NULL;
11631     PL_reg_curpm        = (PMOP*)NULL;
11632     PL_reg_oldsaved     = Nullch;
11633     PL_reg_oldsavedlen  = 0;
11634 #ifdef PERL_COPY_ON_WRITE
11635     PL_nrs              = Nullsv;
11636 #endif
11637     PL_reg_maxiter      = 0;
11638     PL_reg_leftiter     = 0;
11639     PL_reg_poscache     = Nullch;
11640     PL_reg_poscache_size= 0;
11641
11642     /* RE engine - function pointers */
11643     PL_regcompp         = proto_perl->Tregcompp;
11644     PL_regexecp         = proto_perl->Tregexecp;
11645     PL_regint_start     = proto_perl->Tregint_start;
11646     PL_regint_string    = proto_perl->Tregint_string;
11647     PL_regfree          = proto_perl->Tregfree;
11648
11649     PL_reginterp_cnt    = 0;
11650     PL_reg_starttry     = 0;
11651
11652     /* Pluggable optimizer */
11653     PL_peepp            = proto_perl->Tpeepp;
11654
11655     PL_stashcache       = newHV();
11656
11657     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11658         ptr_table_free(PL_ptr_table);
11659         PL_ptr_table = NULL;
11660     }
11661
11662     /* Call the ->CLONE method, if it exists, for each of the stashes
11663        identified by sv_dup() above.
11664     */
11665     while(av_len(param->stashes) != -1) {
11666         HV* stash = (HV*) av_shift(param->stashes);
11667         GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11668         if (cloner && GvCV(cloner)) {
11669             dSP;
11670             ENTER;
11671             SAVETMPS;
11672             PUSHMARK(SP);
11673            XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11674             PUTBACK;
11675             call_sv((SV*)GvCV(cloner), G_DISCARD);
11676             FREETMPS;
11677             LEAVE;
11678         }
11679     }
11680
11681     SvREFCNT_dec(param->stashes);
11682
11683     return my_perl;
11684 }
11685
11686 #endif /* USE_ITHREADS */
11687
11688 /*
11689 =head1 Unicode Support
11690
11691 =for apidoc sv_recode_to_utf8
11692
11693 The encoding is assumed to be an Encode object, on entry the PV
11694 of the sv is assumed to be octets in that encoding, and the sv
11695 will be converted into Unicode (and UTF-8).
11696
11697 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11698 is not a reference, nothing is done to the sv.  If the encoding is not
11699 an C<Encode::XS> Encoding object, bad things will happen.
11700 (See F<lib/encoding.pm> and L<Encode>).
11701
11702 The PV of the sv is returned.
11703
11704 =cut */
11705
11706 char *
11707 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11708 {
11709     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11710         SV *uni;
11711         STRLEN len;
11712         char *s;
11713         dSP;
11714         ENTER;
11715         SAVETMPS;
11716         save_re_context();
11717         PUSHMARK(sp);
11718         EXTEND(SP, 3);
11719         XPUSHs(encoding);
11720         XPUSHs(sv);
11721 /*
11722   NI-S 2002/07/09
11723   Passing sv_yes is wrong - it needs to be or'ed set of constants
11724   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11725   remove converted chars from source.
11726
11727   Both will default the value - let them.
11728
11729         XPUSHs(&PL_sv_yes);
11730 */
11731         PUTBACK;
11732         call_method("decode", G_SCALAR);
11733         SPAGAIN;
11734         uni = POPs;
11735         PUTBACK;
11736         s = SvPV(uni, len);
11737         if (s != SvPVX(sv)) {
11738             SvGROW(sv, len + 1);
11739             Move(s, SvPVX(sv), len, char);
11740             SvCUR_set(sv, len);
11741             SvPVX(sv)[len] = 0;
11742         }
11743         FREETMPS;
11744         LEAVE;
11745         SvUTF8_on(sv);
11746     }
11747     return SvPVX(sv);
11748 }
11749
11750 /*
11751 =for apidoc sv_cat_decode
11752
11753 The encoding is assumed to be an Encode object, the PV of the ssv is
11754 assumed to be octets in that encoding and decoding the input starts
11755 from the position which (PV + *offset) pointed to.  The dsv will be
11756 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
11757 when the string tstr appears in decoding output or the input ends on
11758 the PV of the ssv. The value which the offset points will be modified
11759 to the last input position on the ssv.
11760
11761 Returns TRUE if the terminator was found, else returns FALSE.
11762
11763 =cut */
11764
11765 bool
11766 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11767                    SV *ssv, int *offset, char *tstr, int tlen)
11768 {
11769     bool ret = FALSE;
11770     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11771         SV *offsv;
11772         dSP;
11773         ENTER;
11774         SAVETMPS;
11775         save_re_context();
11776         PUSHMARK(sp);
11777         EXTEND(SP, 6);
11778         XPUSHs(encoding);
11779         XPUSHs(dsv);
11780         XPUSHs(ssv);
11781         XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11782         XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11783         PUTBACK;
11784         call_method("cat_decode", G_SCALAR);
11785         SPAGAIN;
11786         ret = SvTRUE(TOPs);
11787         *offset = SvIV(offsv);
11788         PUTBACK;
11789         FREETMPS;
11790         LEAVE;
11791     }
11792     else
11793         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11794     return ret;
11795 }
11796