sv.c

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