sv.c

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