sv.c

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