sv.c

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