sv.c

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